Remove RenderElement::s_noLongerAffectsParentBlock
[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 class RenderTreeBuilder;
33
34 class RenderElement : public RenderObject {
35     WTF_MAKE_ISO_ALLOCATED(RenderElement);
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
89     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const { return true; }
90     void didAttachChild(RenderObject& child, RenderObject* beforeChild);
91
92     // The following functions are used when the render tree hierarchy changes to make sure layers get
93     // properly added and removed. Since containership can be implemented by any subclass, and since a hierarchy
94     // can contain a mixture of boxes and other object types, these functions need to be in the base class.
95     void addLayers(RenderLayer* parentLayer);
96     void removeLayers(RenderLayer* parentLayer);
97     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
98     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
99
100     virtual RenderElement* hoverAncestor() const;
101
102     virtual void dirtyLinesFromChangedChild(RenderObject&) { }
103
104     bool ancestorLineBoxDirty() const { return m_ancestorLineBoxDirty; }
105     void setAncestorLineBoxDirty(bool f = true);
106
107     void setChildNeedsLayout(MarkingBehavior = MarkContainingBlockChain);
108     void clearChildNeedsLayout();
109     void setNeedsPositionedMovementLayout(const RenderStyle* oldStyle);
110     void setNeedsSimplifiedNormalFlowLayout();
111
112     virtual void paint(PaintInfo&, const LayoutPoint&) = 0;
113
114     // inline-block elements paint all phases atomically. This function ensures that. Certain other elements
115     // (grid items, flex items) require this behavior as well, and this function exists as a helper for them.
116     // It is expected that the caller will call this function independent of the value of paintInfo.phase.
117     void paintAsInlineBlock(PaintInfo&, const LayoutPoint&);
118
119     // Recursive function that computes the size and position of this object and all its descendants.
120     virtual void layout();
121
122     /* This function performs a layout only if one is needed. */
123     void layoutIfNeeded() { if (needsLayout()) layout(); }
124
125     // Updates only the local style ptr of the object. Does not update the state of the object,
126     // and so only should be called when the style is known not to have changed (or from setStyle).
127     void setStyleInternal(RenderStyle&& style) { m_style = WTFMove(style); }
128
129     // Repaint only if our old bounds and new bounds are different. The caller may pass in newBounds and newOutlineBox if they are known.
130     bool repaintAfterLayoutIfNeeded(const RenderLayerModelObject* repaintContainer, const LayoutRect& oldBounds, const LayoutRect& oldOutlineBox, const LayoutRect* newBoundsPtr = nullptr, const LayoutRect* newOutlineBoxPtr = nullptr);
131
132     bool borderImageIsLoadedAndCanBeRendered() const;
133     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
134     bool isVisibleInDocumentRect(const IntRect& documentRect) const;
135
136     // Returns true if this renderer requires a new stacking context.
137     static bool createsGroupForStyle(const RenderStyle&);
138     bool createsGroup() const { return createsGroupForStyle(style()); }
139
140     bool isTransparent() const { return style().opacity() < 1.0f; }
141     float opacity() const { return style().opacity(); }
142
143     bool visibleToHitTesting() const { return style().visibility() == VISIBLE && style().pointerEvents() != PE_NONE; }
144
145     bool hasBackground() const { return style().hasBackground(); }
146     bool hasMask() const { return style().hasMask(); }
147     bool hasClip() const { return isOutOfFlowPositioned() && style().hasClip(); }
148     bool hasClipOrOverflowClip() const { return hasClip() || hasOverflowClip(); }
149     bool hasClipPath() const { return style().clipPath(); }
150     bool hasHiddenBackface() const { return style().backfaceVisibility() == BackfaceVisibilityHidden; }
151     bool hasOutlineAnnotation() const;
152     bool hasOutline() const { return style().hasOutline() || hasOutlineAnnotation(); }
153     bool hasSelfPaintingLayer() const;
154
155     bool checkForRepaintDuringLayout() const;
156
157     // anchorRect() is conceptually similar to absoluteBoundingBoxRect(), but is intended for scrolling to an anchor.
158     // For inline renderers, this gets the logical top left of the first leaf child and the logical bottom right of the
159     // last leaf child, converts them to absolute coordinates, and makes a box out of them.
160     LayoutRect absoluteAnchorRect(bool* insideFixed = nullptr) const;
161
162     bool hasFilter() const { return style().hasFilter(); }
163     bool hasBackdropFilter() const
164     {
165 #if ENABLE(FILTERS_LEVEL_2)
166         return style().hasBackdropFilter();
167 #else
168         return false;
169 #endif
170     }
171
172
173 #if ENABLE(CSS_COMPOSITING)
174     bool hasBlendMode() const { return style().hasBlendMode(); }
175 #else
176     bool hasBlendMode() const { return false; }
177 #endif
178
179     bool hasShapeOutside() const { return style().shapeOutside(); }
180
181     void registerForVisibleInViewportCallback();
182     void unregisterForVisibleInViewportCallback();
183
184     VisibleInViewportState visibleInViewportState() const { return static_cast<VisibleInViewportState>(m_visibleInViewportState); }
185     void setVisibleInViewportState(VisibleInViewportState);
186     virtual void visibleInViewportStateChanged();
187
188     bool repaintForPausedImageAnimationsIfNeeded(const IntRect& visibleRect, CachedImage&);
189     bool hasPausedImageAnimations() const { return m_hasPausedImageAnimations; }
190     void setHasPausedImageAnimations(bool b) { m_hasPausedImageAnimations = b; }
191
192     void setRenderBoxNeedsLazyRepaint(bool b) { m_renderBoxNeedsLazyRepaint = b; }
193     bool renderBoxNeedsLazyRepaint() const { return m_renderBoxNeedsLazyRepaint; }
194
195     bool hasCounterNodeMap() const { return m_hasCounterNodeMap; }
196     void setHasCounterNodeMap(bool f) { m_hasCounterNodeMap = f; }
197
198     const RenderElement* enclosingRendererWithTextDecoration(TextDecoration, bool firstLine) const;
199     void drawLineForBoxSide(GraphicsContext&, const FloatRect&, BoxSide, Color, EBorderStyle, float adjacentWidth1, float adjacentWidth2, bool antialias = false) const;
200
201 #if ENABLE(TEXT_AUTOSIZING)
202     void adjustComputedFontSizesOnBlocks(float size, float visibleWidth);
203     WEBCORE_EXPORT void resetTextAutosizing();
204 #endif
205     RenderBlock* containingBlockForFixedPosition() const;
206     RenderBlock* containingBlockForAbsolutePosition() const;
207
208     RespectImageOrientationEnum shouldRespectImageOrientation() const;
209
210     void removeFromRenderFragmentedFlow();
211     virtual void resetEnclosingFragmentedFlowAndChildInfoIncludingDescendants(RenderFragmentedFlow*);
212
213     // Called before anonymousChild.setStyle(). Override to set custom styles for
214     // the child.
215     virtual void updateAnonymousChildStyle(RenderStyle&) const { };
216
217     bool hasContinuationChainNode() const { return m_hasContinuationChainNode; }
218     bool isContinuation() const { return m_isContinuation; }
219     void setIsContinuation() { m_isContinuation = true; }
220     bool isFirstLetter() const { return m_isFirstLetter; }
221     void setIsFirstLetter() { m_isFirstLetter = true; }
222
223     RenderObject* attachRendererInternal(RenderPtr<RenderObject> child, RenderObject* beforeChild);
224     RenderPtr<RenderObject> detachRendererInternal(RenderObject&);
225
226 protected:
227     enum BaseTypeFlag {
228         RenderLayerModelObjectFlag  = 1 << 0,
229         RenderBoxModelObjectFlag    = 1 << 1,
230         RenderInlineFlag            = 1 << 2,
231         RenderReplacedFlag          = 1 << 3,
232         RenderBlockFlag             = 1 << 4,
233         RenderBlockFlowFlag         = 1 << 5,
234     };
235     
236     typedef unsigned BaseTypeFlags;
237
238     RenderElement(Element&, RenderStyle&&, BaseTypeFlags);
239     RenderElement(Document&, RenderStyle&&, BaseTypeFlags);
240
241     bool layerCreationAllowedForSubtree() const;
242
243     enum StylePropagationType { PropagateToAllChildren, PropagateToBlockChildrenOnly };
244     void propagateStyleToAnonymousChildren(StylePropagationType);
245
246     LayoutUnit valueForLength(const Length&, LayoutUnit maximumValue) const;
247     LayoutUnit minimumValueForLength(const Length&, LayoutUnit maximumValue) const;
248
249     void setFirstChild(RenderObject* child) { m_firstChild = child; }
250     void setLastChild(RenderObject* child) { m_lastChild = child; }
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 setHasContinuationChainNode(bool b) { m_hasContinuationChainNode = 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 removeFromRenderFragmentedFlowIncludingDescendants(bool shouldUpdateState);
281     void adjustFragmentedFlowStateOnContainingBlockChangeIfNeeded();
282     
283     bool isVisibleInViewport() const;
284
285     bool noLongerAffectsParentBlock(const RenderStyle& oldStyle) const;
286
287 private:
288     RenderElement(ContainerNode&, RenderStyle&&, BaseTypeFlags);
289     void node() const = delete;
290     void nonPseudoNode() const = delete;
291     void generatingNode() const = delete;
292     void isText() const = delete;
293     void isRenderElement() const = delete;
294
295     RenderObject* firstChildSlow() const final { return firstChild(); }
296     RenderObject* lastChildSlow() const final { return lastChild(); }
297
298     // Called when an object that was floating or positioned becomes a normal flow object
299     // again.  We have to make sure the render tree updates as needed to accommodate the new
300     // normal flow object.
301     void handleDynamicFloatPositionChange();
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 clearSubtreeLayoutRootIfNeeded() 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_hasContinuationChainNode : 1;
335     unsigned m_isContinuation : 1;
336     unsigned m_isFirstLetter : 1;
337     mutable unsigned m_hasValidCachedFirstLineStyle : 1;
338
339     unsigned m_renderBlockHasMarginBeforeQuirk : 1;
340     unsigned m_renderBlockHasMarginAfterQuirk : 1;
341     unsigned m_renderBlockShouldForceRelayoutChildren : 1;
342     unsigned m_renderBlockFlowHasMarkupTruncation : 1;
343     unsigned m_renderBlockFlowLineLayoutPath : 2;
344
345     unsigned m_isRegisteredForVisibleInViewportCallback : 1;
346     unsigned m_visibleInViewportState : 2;
347
348     RenderObject* m_firstChild;
349     RenderObject* m_lastChild;
350
351     RenderStyle m_style;
352 };
353
354 inline void RenderElement::setAncestorLineBoxDirty(bool f)
355 {
356     m_ancestorLineBoxDirty = f;
357     if (m_ancestorLineBoxDirty)
358         setNeedsLayout();
359 }
360
361 inline void RenderElement::setChildNeedsLayout(MarkingBehavior markParents)
362 {
363     ASSERT(!isSetNeedsLayoutForbidden());
364     if (normalChildNeedsLayout())
365         return;
366     setNormalChildNeedsLayoutBit(true);
367     if (markParents == MarkContainingBlockChain)
368         markContainingBlocksForLayout();
369 }
370
371 inline LayoutUnit RenderElement::valueForLength(const Length& length, LayoutUnit maximumValue) const
372 {
373     return WebCore::valueForLength(length, maximumValue);
374 }
375
376 inline LayoutUnit RenderElement::minimumValueForLength(const Length& length, LayoutUnit maximumValue) const
377 {
378     return WebCore::minimumValueForLength(length, maximumValue);
379 }
380
381 inline bool RenderElement::isRenderLayerModelObject() const
382 {
383     return m_baseTypeFlags & RenderLayerModelObjectFlag;
384 }
385
386 inline bool RenderElement::isBoxModelObject() const
387 {
388     return m_baseTypeFlags & RenderBoxModelObjectFlag;
389 }
390
391 inline bool RenderElement::isRenderBlock() const
392 {
393     return m_baseTypeFlags & RenderBlockFlag;
394 }
395
396 inline bool RenderElement::isRenderBlockFlow() const
397 {
398     return m_baseTypeFlags & RenderBlockFlowFlag;
399 }
400
401 inline bool RenderElement::isRenderReplaced() const
402 {
403     return m_baseTypeFlags & RenderReplacedFlag;
404 }
405
406 inline bool RenderElement::isRenderInline() const
407 {
408     return m_baseTypeFlags & RenderInlineFlag;
409 }
410
411 inline Element* RenderElement::generatingElement() const
412 {
413     return downcast<Element>(RenderObject::generatingNode());
414 }
415
416 inline bool RenderElement::canContainFixedPositionObjects() const
417 {
418     return isRenderView()
419         || (hasTransform() && isRenderBlock())
420         || isSVGForeignObject()
421         || isOutOfFlowRenderFragmentedFlow();
422 }
423
424 inline bool RenderElement::canContainAbsolutelyPositionedObjects() const
425 {
426     return style().position() != StaticPosition
427         || (isRenderBlock() && hasTransformRelatedProperty())
428         || isSVGForeignObject()
429         || isRenderView();
430 }
431
432 inline bool RenderElement::createsGroupForStyle(const RenderStyle& style)
433 {
434     return style.opacity() < 1.0f || style.hasMask() || style.clipPath() || style.hasFilter() || style.hasBackdropFilter() || style.hasBlendMode();
435 }
436
437 inline bool RenderObject::isRenderLayerModelObject() const
438 {
439     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderLayerModelObject();
440 }
441
442 inline bool RenderObject::isBoxModelObject() const
443 {
444     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isBoxModelObject();
445 }
446
447 inline bool RenderObject::isRenderBlock() const
448 {
449     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlock();
450 }
451
452 inline bool RenderObject::isRenderBlockFlow() const
453 {
454     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlockFlow();
455 }
456
457 inline bool RenderObject::isRenderReplaced() const
458 {
459     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderReplaced();
460 }
461
462 inline bool RenderObject::isRenderInline() const
463 {
464     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderInline();
465 }
466
467 inline const RenderStyle& RenderObject::style() const
468 {
469     if (isText())
470         return m_parent->style();
471     return downcast<RenderElement>(*this).style();
472 }
473
474 inline const RenderStyle& RenderObject::firstLineStyle() const
475 {
476     if (isText())
477         return m_parent->firstLineStyle();
478     return downcast<RenderElement>(*this).firstLineStyle();
479 }
480
481 inline RenderElement* ContainerNode::renderer() const
482 {
483     return downcast<RenderElement>(Node::renderer());
484 }
485
486 inline int adjustForAbsoluteZoom(int value, const RenderElement& renderer)
487 {
488     return adjustForAbsoluteZoom(value, renderer.style());
489 }
490
491 inline LayoutUnit adjustLayoutUnitForAbsoluteZoom(LayoutUnit value, const RenderElement& renderer)
492 {
493     return adjustLayoutUnitForAbsoluteZoom(value, renderer.style());
494 }
495
496 } // namespace WebCore
497
498 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderElement, isRenderElement())