Enable fieldsets to be flexboxes, grids and multicolumn.
[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     bool createsGroup() const { return isTransparent() || hasMask() || hasClipPath() || hasFilter() || hasBackdropFilter() || hasBlendMode(); }
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     void visibleInViewportStateChanged(VisibleInViewportState);
189
190     bool repaintForPausedImageAnimationsIfNeeded(const IntRect& visibleRect);
191     bool hasPausedImageAnimations() const { return m_hasPausedImageAnimations; }
192     void setHasPausedImageAnimations(bool b) { m_hasPausedImageAnimations = b; }
193
194     void setRenderBoxNeedsLazyRepaint(bool b) { m_renderBoxNeedsLazyRepaint = b; }
195     bool renderBoxNeedsLazyRepaint() const { return m_renderBoxNeedsLazyRepaint; }
196
197     bool hasCounterNodeMap() const { return m_hasCounterNodeMap; }
198     void setHasCounterNodeMap(bool f) { m_hasCounterNodeMap = f; }
199
200     bool isCSSAnimating() const { return m_isCSSAnimating; }
201     void setIsCSSAnimating(bool b) { m_isCSSAnimating = b; }
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
220     // Called before anonymousChild.setStyle(). Override to set custom styles for
221     // the child.
222     virtual void updateAnonymousChildStyle(const RenderObject&, RenderStyle&) const { };
223
224 protected:
225     enum BaseTypeFlag {
226         RenderLayerModelObjectFlag  = 1 << 0,
227         RenderBoxModelObjectFlag    = 1 << 1,
228         RenderInlineFlag            = 1 << 2,
229         RenderReplacedFlag          = 1 << 3,
230         RenderBlockFlag             = 1 << 4,
231         RenderBlockFlowFlag         = 1 << 5,
232     };
233     
234     typedef unsigned BaseTypeFlags;
235
236     RenderElement(Element&, RenderStyle&&, BaseTypeFlags);
237     RenderElement(Document&, RenderStyle&&, BaseTypeFlags);
238
239     bool layerCreationAllowedForSubtree() const;
240
241     enum StylePropagationType { PropagateToAllChildren, PropagateToBlockChildrenOnly };
242     void propagateStyleToAnonymousChildren(StylePropagationType);
243
244     LayoutUnit valueForLength(const Length&, LayoutUnit maximumValue) const;
245     LayoutUnit minimumValueForLength(const Length&, LayoutUnit maximumValue) const;
246
247     void setFirstChild(RenderObject* child) { m_firstChild = child; }
248     void setLastChild(RenderObject* child) { m_lastChild = child; }
249     void destroyLeftoverChildren();
250
251     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle);
252     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
253
254     void insertedIntoTree() override;
255     void willBeRemovedFromTree() override;
256     void willBeDestroyed() override;
257
258     void setRenderInlineAlwaysCreatesLineBoxes(bool b) { m_renderInlineAlwaysCreatesLineBoxes = b; }
259     bool renderInlineAlwaysCreatesLineBoxes() const { return m_renderInlineAlwaysCreatesLineBoxes; }
260
261     void setHasContinuation(bool b) { m_hasContinuation = b; }
262
263     void setRenderBlockHasMarginBeforeQuirk(bool b) { m_renderBlockHasMarginBeforeQuirk = b; }
264     void setRenderBlockHasMarginAfterQuirk(bool b) { m_renderBlockHasMarginAfterQuirk = b; }
265     void setRenderBlockShouldForceRelayoutChildren(bool b) { m_renderBlockShouldForceRelayoutChildren = b; }
266     bool renderBlockHasMarginBeforeQuirk() const { return m_renderBlockHasMarginBeforeQuirk; }
267     bool renderBlockHasMarginAfterQuirk() const { return m_renderBlockHasMarginAfterQuirk; }
268     bool renderBlockShouldForceRelayoutChildren() const { return m_renderBlockShouldForceRelayoutChildren; }
269
270     void setRenderBlockFlowLineLayoutPath(unsigned u) { m_renderBlockFlowLineLayoutPath = u; }
271     void setRenderBlockFlowHasMarkupTruncation(bool b) { m_renderBlockFlowHasMarkupTruncation = b; }
272     unsigned renderBlockFlowLineLayoutPath() const { return m_renderBlockFlowLineLayoutPath; }
273     bool renderBlockFlowHasMarkupTruncation() const { return m_renderBlockFlowHasMarkupTruncation; }
274
275     void paintFocusRing(PaintInfo&, const RenderStyle&, const Vector<LayoutRect>& focusRingRects);
276     void paintOutline(PaintInfo&, const LayoutRect&);
277     void updateOutlineAutoAncestor(bool hasOutlineAuto);
278
279     void removeFromRenderFlowThreadIncludingDescendants(bool shouldUpdateState);
280     void adjustFlowThreadStateOnContainingBlockChangeIfNeeded();
281
282 private:
283     RenderElement(ContainerNode&, RenderStyle&&, BaseTypeFlags);
284     void node() const = delete;
285     void nonPseudoNode() const = delete;
286     void generatingNode() const = delete;
287     void isText() const = delete;
288     void isRenderElement() const = delete;
289
290     RenderObject* firstChildSlow() const final { return firstChild(); }
291     RenderObject* lastChildSlow() const final { return lastChild(); }
292
293     // Called when an object that was floating or positioned becomes a normal flow object
294     // again.  We have to make sure the render tree updates as needed to accommodate the new
295     // normal flow object.
296     void handleDynamicFloatPositionChange();
297     void removeAnonymousWrappersForInlinesIfNecessary();
298
299     bool shouldRepaintForStyleDifference(StyleDifference) const;
300     bool hasImmediateNonWhitespaceTextChildOrBorderOrOutline() const;
301
302     void updateFillImages(const FillLayer*, const FillLayer&);
303     void updateImage(StyleImage*, StyleImage*);
304     void updateShapeImage(const ShapeValue*, const ShapeValue*);
305
306     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
307     std::unique_ptr<RenderStyle> computeFirstLineStyle() const;
308     void invalidateCachedFirstLineStyle();
309
310     void newImageAnimationFrameAvailable(CachedImage&) final;
311
312     bool getLeadingCorner(FloatPoint& output, bool& insideFixed) const;
313     bool getTrailingCorner(FloatPoint& output, bool& insideFixed) const;
314
315     void clearLayoutRootIfNeeded() const;
316     
317     bool shouldWillChangeCreateStackingContext() const;
318     void issueRepaintForOutlineAuto(float outlineSize);
319
320     unsigned m_baseTypeFlags : 6;
321     unsigned m_ancestorLineBoxDirty : 1;
322     unsigned m_hasInitializedStyle : 1;
323
324     unsigned m_renderInlineAlwaysCreatesLineBoxes : 1;
325     unsigned m_renderBoxNeedsLazyRepaint : 1;
326     unsigned m_hasPausedImageAnimations : 1;
327     unsigned m_hasCounterNodeMap : 1;
328     unsigned m_isCSSAnimating : 1;
329     unsigned m_hasContinuation : 1;
330     mutable unsigned m_hasValidCachedFirstLineStyle : 1;
331
332     unsigned m_renderBlockHasMarginBeforeQuirk : 1;
333     unsigned m_renderBlockHasMarginAfterQuirk : 1;
334     unsigned m_renderBlockShouldForceRelayoutChildren : 1;
335     unsigned m_renderBlockFlowHasMarkupTruncation : 1;
336     unsigned m_renderBlockFlowLineLayoutPath : 2;
337
338     RenderObject* m_firstChild;
339     RenderObject* m_lastChild;
340
341     RenderStyle m_style;
342
343     // FIXME: Get rid of this hack.
344     // Store state between styleWillChange and styleDidChange
345     static bool s_affectsParentBlock;
346     static bool s_noLongerAffectsParentBlock;
347
348 protected:
349 #if !ASSERT_DISABLED
350     bool m_reparentingChild { false };
351 #endif
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     if (parent() && isRenderNamedFlowFragment())
414         return parent()->generatingElement();
415     return downcast<Element>(RenderObject::generatingNode());
416 }
417
418 inline bool RenderElement::canContainFixedPositionObjects() const
419 {
420     return isRenderView()
421         || (hasTransform() && isRenderBlock())
422         || isSVGForeignObject()
423         || isOutOfFlowRenderFlowThread();
424 }
425
426 inline bool RenderElement::canContainAbsolutelyPositionedObjects() const
427 {
428     return style().position() != StaticPosition
429         || (isRenderBlock() && hasTransformRelatedProperty())
430         || isSVGForeignObject()
431         || isRenderView();
432 }
433
434 inline bool RenderObject::isRenderLayerModelObject() const
435 {
436     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderLayerModelObject();
437 }
438
439 inline bool RenderObject::isBoxModelObject() const
440 {
441     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isBoxModelObject();
442 }
443
444 inline bool RenderObject::isRenderBlock() const
445 {
446     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlock();
447 }
448
449 inline bool RenderObject::isRenderBlockFlow() const
450 {
451     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlockFlow();
452 }
453
454 inline bool RenderObject::isRenderReplaced() const
455 {
456     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderReplaced();
457 }
458
459 inline bool RenderObject::isRenderInline() const
460 {
461     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderInline();
462 }
463
464 inline const RenderStyle& RenderObject::style() const
465 {
466     if (isText())
467         return m_parent->style();
468     return downcast<RenderElement>(*this).style();
469 }
470
471 inline const RenderStyle& RenderObject::firstLineStyle() const
472 {
473     if (isText())
474         return m_parent->firstLineStyle();
475     return downcast<RenderElement>(*this).firstLineStyle();
476 }
477
478 inline RenderElement* ContainerNode::renderer() const
479 {
480     return downcast<RenderElement>(Node::renderer());
481 }
482
483 inline int adjustForAbsoluteZoom(int value, const RenderElement& renderer)
484 {
485     return adjustForAbsoluteZoom(value, renderer.style());
486 }
487
488 inline LayoutUnit adjustLayoutUnitForAbsoluteZoom(LayoutUnit value, const RenderElement& renderer)
489 {
490     return adjustLayoutUnitForAbsoluteZoom(value, renderer.style());
491 }
492
493 } // namespace WebCore
494
495 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderElement, isRenderElement())