[RenderTreeBuilder] Move RenderButton::addChild() tree mutation to RenderTreeBuilder
[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     virtual void addChild(RenderTreeBuilder&, RenderPtr<RenderObject>, RenderObject* beforeChild);
91     virtual void addChildIgnoringContinuation(RenderTreeBuilder&, RenderPtr<RenderObject> newChild, RenderObject* beforeChild = nullptr);
92     virtual RenderPtr<RenderObject> takeChild(RenderObject&) WARN_UNUSED_RETURN;
93     void removeAndDestroyChild(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     void insertChildInternal(RenderPtr<RenderObject>, RenderObject* beforeChild);
104     RenderPtr<RenderObject> takeChildInternal(RenderObject&) WARN_UNUSED_RETURN;
105
106     virtual RenderElement* hoverAncestor() const;
107
108     virtual void dirtyLinesFromChangedChild(RenderObject&) { }
109
110     bool ancestorLineBoxDirty() const { return m_ancestorLineBoxDirty; }
111     void setAncestorLineBoxDirty(bool f = true);
112
113     void setChildNeedsLayout(MarkingBehavior = MarkContainingBlockChain);
114     void clearChildNeedsLayout();
115     void setNeedsPositionedMovementLayout(const RenderStyle* oldStyle);
116     void setNeedsSimplifiedNormalFlowLayout();
117
118     virtual void paint(PaintInfo&, const LayoutPoint&) = 0;
119
120     // inline-block elements paint all phases atomically. This function ensures that. Certain other elements
121     // (grid items, flex items) require this behavior as well, and this function exists as a helper for them.
122     // It is expected that the caller will call this function independent of the value of paintInfo.phase.
123     void paintAsInlineBlock(PaintInfo&, const LayoutPoint&);
124
125     // Recursive function that computes the size and position of this object and all its descendants.
126     virtual void layout();
127
128     /* This function performs a layout only if one is needed. */
129     void layoutIfNeeded() { if (needsLayout()) layout(); }
130
131     // Updates only the local style ptr of the object. Does not update the state of the object,
132     // and so only should be called when the style is known not to have changed (or from setStyle).
133     void setStyleInternal(RenderStyle&& style) { m_style = WTFMove(style); }
134
135     // Repaint only if our old bounds and new bounds are different. The caller may pass in newBounds and newOutlineBox if they are known.
136     bool repaintAfterLayoutIfNeeded(const RenderLayerModelObject* repaintContainer, const LayoutRect& oldBounds, const LayoutRect& oldOutlineBox, const LayoutRect* newBoundsPtr = nullptr, const LayoutRect* newOutlineBoxPtr = nullptr);
137
138     bool borderImageIsLoadedAndCanBeRendered() const;
139     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
140     bool isVisibleInDocumentRect(const IntRect& documentRect) 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     VisibleInViewportState visibleInViewportState() const { return static_cast<VisibleInViewportState>(m_visibleInViewportState); }
191     void setVisibleInViewportState(VisibleInViewportState);
192     virtual void visibleInViewportStateChanged();
193
194     bool repaintForPausedImageAnimationsIfNeeded(const IntRect& visibleRect, CachedImage&);
195     bool hasPausedImageAnimations() const { return m_hasPausedImageAnimations; }
196     void setHasPausedImageAnimations(bool b) { m_hasPausedImageAnimations = b; }
197
198     void setRenderBoxNeedsLazyRepaint(bool b) { m_renderBoxNeedsLazyRepaint = b; }
199     bool renderBoxNeedsLazyRepaint() const { return m_renderBoxNeedsLazyRepaint; }
200
201     bool hasCounterNodeMap() const { return m_hasCounterNodeMap; }
202     void setHasCounterNodeMap(bool f) { m_hasCounterNodeMap = f; }
203
204     const RenderElement* enclosingRendererWithTextDecoration(TextDecoration, bool firstLine) const;
205     void drawLineForBoxSide(GraphicsContext&, const FloatRect&, BoxSide, Color, EBorderStyle, float adjacentWidth1, float adjacentWidth2, bool antialias = false) const;
206
207     bool childRequiresTable(const RenderObject& child) const;
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 removeFromRenderFragmentedFlow();
219     virtual void resetEnclosingFragmentedFlowAndChildInfoIncludingDescendants(RenderFragmentedFlow*);
220
221     // Called before anonymousChild.setStyle(). Override to set custom styles for
222     // the child.
223     virtual void updateAnonymousChildStyle(RenderStyle&) const { };
224
225     void removeAnonymousWrappersForInlinesIfNecessary();
226
227     bool hasContinuationChainNode() const { return m_hasContinuationChainNode; }
228     bool isContinuation() const { return m_isContinuation; }
229     void setIsContinuation() { m_isContinuation = true; }
230     bool isFirstLetter() const { return m_isFirstLetter; }
231     void setIsFirstLetter() { m_isFirstLetter = true; }
232
233     void destroyLeftoverChildren();
234
235 protected:
236     enum BaseTypeFlag {
237         RenderLayerModelObjectFlag  = 1 << 0,
238         RenderBoxModelObjectFlag    = 1 << 1,
239         RenderInlineFlag            = 1 << 2,
240         RenderReplacedFlag          = 1 << 3,
241         RenderBlockFlag             = 1 << 4,
242         RenderBlockFlowFlag         = 1 << 5,
243     };
244     
245     typedef unsigned BaseTypeFlags;
246
247     RenderElement(Element&, RenderStyle&&, BaseTypeFlags);
248     RenderElement(Document&, RenderStyle&&, BaseTypeFlags);
249
250     bool layerCreationAllowedForSubtree() const;
251
252     enum StylePropagationType { PropagateToAllChildren, PropagateToBlockChildrenOnly };
253     void propagateStyleToAnonymousChildren(StylePropagationType);
254
255     LayoutUnit valueForLength(const Length&, LayoutUnit maximumValue) const;
256     LayoutUnit minimumValueForLength(const Length&, LayoutUnit maximumValue) const;
257
258     void setFirstChild(RenderObject* child) { m_firstChild = child; }
259     void setLastChild(RenderObject* child) { m_lastChild = child; }
260
261     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle);
262     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
263
264     void insertedIntoTree() override;
265     void willBeRemovedFromTree() override;
266     void willBeDestroyed() override;
267
268     void setRenderInlineAlwaysCreatesLineBoxes(bool b) { m_renderInlineAlwaysCreatesLineBoxes = b; }
269     bool renderInlineAlwaysCreatesLineBoxes() const { return m_renderInlineAlwaysCreatesLineBoxes; }
270
271     void setHasContinuationChainNode(bool b) { m_hasContinuationChainNode = b; }
272
273     void setRenderBlockHasMarginBeforeQuirk(bool b) { m_renderBlockHasMarginBeforeQuirk = b; }
274     void setRenderBlockHasMarginAfterQuirk(bool b) { m_renderBlockHasMarginAfterQuirk = b; }
275     void setRenderBlockShouldForceRelayoutChildren(bool b) { m_renderBlockShouldForceRelayoutChildren = b; }
276     bool renderBlockHasMarginBeforeQuirk() const { return m_renderBlockHasMarginBeforeQuirk; }
277     bool renderBlockHasMarginAfterQuirk() const { return m_renderBlockHasMarginAfterQuirk; }
278     bool renderBlockShouldForceRelayoutChildren() const { return m_renderBlockShouldForceRelayoutChildren; }
279
280     void setRenderBlockFlowLineLayoutPath(unsigned u) { m_renderBlockFlowLineLayoutPath = u; }
281     void setRenderBlockFlowHasMarkupTruncation(bool b) { m_renderBlockFlowHasMarkupTruncation = b; }
282     unsigned renderBlockFlowLineLayoutPath() const { return m_renderBlockFlowLineLayoutPath; }
283     bool renderBlockFlowHasMarkupTruncation() const { return m_renderBlockFlowHasMarkupTruncation; }
284
285     void paintFocusRing(PaintInfo&, const RenderStyle&, const Vector<LayoutRect>& focusRingRects);
286     void paintOutline(PaintInfo&, const LayoutRect&);
287     void updateOutlineAutoAncestor(bool hasOutlineAuto);
288
289     void removeFromRenderFragmentedFlowIncludingDescendants(bool shouldUpdateState);
290     void adjustFragmentedFlowStateOnContainingBlockChangeIfNeeded();
291     
292     bool noLongerAffectsParentBlock() const { return s_noLongerAffectsParentBlock; }
293     bool isVisibleInViewport() const;
294
295 private:
296     RenderElement(ContainerNode&, RenderStyle&&, BaseTypeFlags);
297     void node() const = delete;
298     void nonPseudoNode() const = delete;
299     void generatingNode() const = delete;
300     void isText() const = delete;
301     void isRenderElement() const = delete;
302
303     RenderObject* firstChildSlow() const final { return firstChild(); }
304     RenderObject* lastChildSlow() const final { return lastChild(); }
305
306     // Called when an object that was floating or positioned becomes a normal flow object
307     // again.  We have to make sure the render tree updates as needed to accommodate the new
308     // normal flow object.
309     void handleDynamicFloatPositionChange();
310
311     bool shouldRepaintForStyleDifference(StyleDifference) const;
312     bool hasImmediateNonWhitespaceTextChildOrBorderOrOutline() const;
313
314     void updateFillImages(const FillLayer*, const FillLayer&);
315     void updateImage(StyleImage*, StyleImage*);
316     void updateShapeImage(const ShapeValue*, const ShapeValue*);
317
318     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
319     std::unique_ptr<RenderStyle> computeFirstLineStyle() const;
320     void invalidateCachedFirstLineStyle();
321
322     bool canDestroyDecodedData() final { return !isVisibleInViewport(); }
323     VisibleInViewportState imageFrameAvailable(CachedImage&, ImageAnimatingState, const IntRect* changeRect) final;
324     void didRemoveCachedImageClient(CachedImage&) final;
325
326     bool getLeadingCorner(FloatPoint& output, bool& insideFixed) const;
327     bool getTrailingCorner(FloatPoint& output, bool& insideFixed) const;
328
329     void clearSubtreeLayoutRootIfNeeded() const;
330     
331     bool shouldWillChangeCreateStackingContext() const;
332     void issueRepaintForOutlineAuto(float outlineSize);
333
334     unsigned m_baseTypeFlags : 6;
335     unsigned m_ancestorLineBoxDirty : 1;
336     unsigned m_hasInitializedStyle : 1;
337
338     unsigned m_renderInlineAlwaysCreatesLineBoxes : 1;
339     unsigned m_renderBoxNeedsLazyRepaint : 1;
340     unsigned m_hasPausedImageAnimations : 1;
341     unsigned m_hasCounterNodeMap : 1;
342     unsigned m_hasContinuationChainNode : 1;
343     unsigned m_isContinuation : 1;
344     unsigned m_isFirstLetter : 1;
345     mutable unsigned m_hasValidCachedFirstLineStyle : 1;
346
347     unsigned m_renderBlockHasMarginBeforeQuirk : 1;
348     unsigned m_renderBlockHasMarginAfterQuirk : 1;
349     unsigned m_renderBlockShouldForceRelayoutChildren : 1;
350     unsigned m_renderBlockFlowHasMarkupTruncation : 1;
351     unsigned m_renderBlockFlowLineLayoutPath : 2;
352
353     unsigned m_isRegisteredForVisibleInViewportCallback : 1;
354     unsigned m_visibleInViewportState : 2;
355
356     RenderObject* m_firstChild;
357     RenderObject* m_lastChild;
358
359     RenderStyle m_style;
360
361     // FIXME: Get rid of this hack.
362     // Store state between styleWillChange and styleDidChange
363     static bool s_affectsParentBlock;
364     static bool s_noLongerAffectsParentBlock;
365 };
366
367 inline void RenderElement::setAncestorLineBoxDirty(bool f)
368 {
369     m_ancestorLineBoxDirty = f;
370     if (m_ancestorLineBoxDirty)
371         setNeedsLayout();
372 }
373
374 inline void RenderElement::setChildNeedsLayout(MarkingBehavior markParents)
375 {
376     ASSERT(!isSetNeedsLayoutForbidden());
377     if (normalChildNeedsLayout())
378         return;
379     setNormalChildNeedsLayoutBit(true);
380     if (markParents == MarkContainingBlockChain)
381         markContainingBlocksForLayout();
382 }
383
384 inline LayoutUnit RenderElement::valueForLength(const Length& length, LayoutUnit maximumValue) const
385 {
386     return WebCore::valueForLength(length, maximumValue);
387 }
388
389 inline LayoutUnit RenderElement::minimumValueForLength(const Length& length, LayoutUnit maximumValue) const
390 {
391     return WebCore::minimumValueForLength(length, maximumValue);
392 }
393
394 inline bool RenderElement::isRenderLayerModelObject() const
395 {
396     return m_baseTypeFlags & RenderLayerModelObjectFlag;
397 }
398
399 inline bool RenderElement::isBoxModelObject() const
400 {
401     return m_baseTypeFlags & RenderBoxModelObjectFlag;
402 }
403
404 inline bool RenderElement::isRenderBlock() const
405 {
406     return m_baseTypeFlags & RenderBlockFlag;
407 }
408
409 inline bool RenderElement::isRenderBlockFlow() const
410 {
411     return m_baseTypeFlags & RenderBlockFlowFlag;
412 }
413
414 inline bool RenderElement::isRenderReplaced() const
415 {
416     return m_baseTypeFlags & RenderReplacedFlag;
417 }
418
419 inline bool RenderElement::isRenderInline() const
420 {
421     return m_baseTypeFlags & RenderInlineFlag;
422 }
423
424 inline Element* RenderElement::generatingElement() const
425 {
426     return downcast<Element>(RenderObject::generatingNode());
427 }
428
429 inline bool RenderElement::canContainFixedPositionObjects() const
430 {
431     return isRenderView()
432         || (hasTransform() && isRenderBlock())
433         || isSVGForeignObject()
434         || isOutOfFlowRenderFragmentedFlow();
435 }
436
437 inline bool RenderElement::canContainAbsolutelyPositionedObjects() const
438 {
439     return style().position() != StaticPosition
440         || (isRenderBlock() && hasTransformRelatedProperty())
441         || isSVGForeignObject()
442         || isRenderView();
443 }
444
445 inline bool RenderElement::createsGroupForStyle(const RenderStyle& style)
446 {
447     return style.opacity() < 1.0f || style.hasMask() || style.clipPath() || style.hasFilter() || style.hasBackdropFilter() || style.hasBlendMode();
448 }
449
450 inline bool RenderObject::isRenderLayerModelObject() const
451 {
452     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderLayerModelObject();
453 }
454
455 inline bool RenderObject::isBoxModelObject() const
456 {
457     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isBoxModelObject();
458 }
459
460 inline bool RenderObject::isRenderBlock() const
461 {
462     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlock();
463 }
464
465 inline bool RenderObject::isRenderBlockFlow() const
466 {
467     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlockFlow();
468 }
469
470 inline bool RenderObject::isRenderReplaced() const
471 {
472     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderReplaced();
473 }
474
475 inline bool RenderObject::isRenderInline() const
476 {
477     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderInline();
478 }
479
480 inline const RenderStyle& RenderObject::style() const
481 {
482     if (isText())
483         return m_parent->style();
484     return downcast<RenderElement>(*this).style();
485 }
486
487 inline const RenderStyle& RenderObject::firstLineStyle() const
488 {
489     if (isText())
490         return m_parent->firstLineStyle();
491     return downcast<RenderElement>(*this).firstLineStyle();
492 }
493
494 inline RenderElement* ContainerNode::renderer() const
495 {
496     return downcast<RenderElement>(Node::renderer());
497 }
498
499 inline int adjustForAbsoluteZoom(int value, const RenderElement& renderer)
500 {
501     return adjustForAbsoluteZoom(value, renderer.style());
502 }
503
504 inline LayoutUnit adjustLayoutUnitForAbsoluteZoom(LayoutUnit value, const RenderElement& renderer)
505 {
506     return adjustLayoutUnitForAbsoluteZoom(value, renderer.style());
507 }
508
509 } // namespace WebCore
510
511 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderElement, isRenderElement())