will-change should sometimes trigger compositing
[WebKit-https.git] / Source / WebCore / rendering / RenderInline.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef RenderInline_h
24 #define RenderInline_h
25
26 #include "InlineFlowBox.h"
27 #include "RenderBoxModelObject.h"
28 #include "RenderLineBoxList.h"
29
30 namespace WebCore {
31
32 class Position;
33 class RenderRegion;
34
35 class RenderInline : public RenderBoxModelObject {
36 public:
37     RenderInline(Element&, Ref<RenderStyle>&&);
38     RenderInline(Document&, Ref<RenderStyle>&&);
39
40     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) override;
41
42     virtual LayoutUnit marginLeft() const override final;
43     virtual LayoutUnit marginRight() const override final;
44     virtual LayoutUnit marginTop() const override final;
45     virtual LayoutUnit marginBottom() const override final;
46     virtual LayoutUnit marginBefore(const RenderStyle* otherStyle = 0) const override final;
47     virtual LayoutUnit marginAfter(const RenderStyle* otherStyle = 0) const override final;
48     virtual LayoutUnit marginStart(const RenderStyle* otherStyle = 0) const override final;
49     virtual LayoutUnit marginEnd(const RenderStyle* otherStyle = 0) const override final;
50
51     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override final;
52     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
53
54     virtual LayoutSize offsetFromContainer(RenderElement&, const LayoutPoint&, bool* offsetDependsOnPoint = nullptr) const override final;
55
56     virtual IntRect borderBoundingBox() const override final
57     {
58         IntRect boundingBox = linesBoundingBox();
59         return IntRect(0, 0, boundingBox.width(), boundingBox.height());
60     }
61
62     WEBCORE_EXPORT IntRect linesBoundingBox() const;
63     LayoutRect linesVisualOverflowBoundingBox() const;
64     LayoutRect linesVisualOverflowBoundingBoxInRegion(const RenderRegion*) const;
65
66     InlineFlowBox* createAndAppendInlineFlowBox();
67
68     void dirtyLineBoxes(bool fullLayout);
69     void deleteLines();
70
71     RenderLineBoxList& lineBoxes() { return m_lineBoxes; }
72     const RenderLineBoxList& lineBoxes() const { return m_lineBoxes; }
73
74     InlineFlowBox* firstLineBox() const { return m_lineBoxes.firstLineBox(); }
75     InlineFlowBox* lastLineBox() const { return m_lineBoxes.lastLineBox(); }
76     InlineBox* firstLineBoxIncludingCulling() const { return alwaysCreateLineBoxes() ? firstLineBox() : culledInlineFirstLineBox(); }
77     InlineBox* lastLineBoxIncludingCulling() const { return alwaysCreateLineBoxes() ? lastLineBox() : culledInlineLastLineBox(); }
78
79 #if PLATFORM(IOS)
80     virtual void absoluteQuadsForSelection(Vector<FloatQuad>& quads) const override;
81 #endif
82
83     virtual RenderBoxModelObject* virtualContinuation() const override final { return continuation(); }
84     RenderInline* inlineElementContinuation() const;
85
86     virtual void updateDragState(bool dragOn) override final;
87     
88     LayoutSize offsetForInFlowPositionedInline(const RenderBox* child) const;
89
90     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer = 0) override final;
91     void paintOutline(PaintInfo&, const LayoutPoint&);
92
93     using RenderBoxModelObject::continuation;
94     using RenderBoxModelObject::setContinuation;
95
96     bool alwaysCreateLineBoxes() const { return renderInlineAlwaysCreatesLineBoxes(); }
97     void setAlwaysCreateLineBoxes() { setRenderInlineAlwaysCreatesLineBoxes(true); }
98     void updateAlwaysCreateLineBoxes(bool fullLayout);
99
100     virtual LayoutRect localCaretRect(InlineBox*, int, LayoutUnit* extraWidthToEndOfLine) override final;
101
102     bool hitTestCulledInline(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset);
103
104 protected:
105     virtual void willBeDestroyed() override;
106
107     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
108
109     virtual void updateFromStyle() override;
110
111 private:
112     virtual const char* renderName() const override;
113
114     virtual bool canHaveChildren() const override final { return true; }
115
116     LayoutRect culledInlineVisualOverflowBoundingBox() const;
117     InlineBox* culledInlineFirstLineBox() const;
118     InlineBox* culledInlineLastLineBox() const;
119
120     template<typename GeneratorContext>
121     void generateLineBoxRects(GeneratorContext& yield) const;
122     template<typename GeneratorContext>
123     void generateCulledLineBoxRects(GeneratorContext& yield, const RenderInline* container) const;
124
125     void addChildToContinuation(RenderObject* newChild, RenderObject* beforeChild);
126     virtual void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild = nullptr) override final;
127
128     void splitInlines(RenderBlock* fromBlock, RenderBlock* toBlock, RenderBlock* middleBlock,
129                       RenderObject* beforeChild, RenderBoxModelObject* oldCont);
130     void splitFlow(RenderObject* beforeChild, RenderBlock* newBlockBox,
131                    RenderObject* newChild, RenderBoxModelObject* oldCont);
132
133     virtual void layout() override final { ASSERT_NOT_REACHED(); } // Do nothing for layout()
134
135     virtual void paint(PaintInfo&, const LayoutPoint&) override final;
136
137     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override final;
138
139     virtual bool requiresLayer() const override { return isInFlowPositioned() || createsGroup() || hasClipPath() || willChangeCreatesStackingContext(); }
140
141     virtual LayoutUnit offsetLeft() const override final;
142     virtual LayoutUnit offsetTop() const override final;
143     virtual LayoutUnit offsetWidth() const override final { return linesBoundingBox().width(); }
144     virtual LayoutUnit offsetHeight() const override final { return linesBoundingBox().height(); }
145
146     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override;
147     virtual LayoutRect rectWithOutlineForRepaint(const RenderLayerModelObject* repaintContainer, LayoutUnit outlineWidth) const override final;
148     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed) const override final;
149
150     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
151     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
152
153     virtual VisiblePosition positionForPoint(const LayoutPoint&, const RenderRegion*) override final;
154
155     virtual LayoutRect frameRectForStickyPositioning() const override final { return linesBoundingBox(); }
156
157     virtual std::unique_ptr<InlineFlowBox> createInlineFlowBox(); // Subclassed by RenderSVGInline
158
159     virtual void dirtyLinesFromChangedChild(RenderObject& child) override final { m_lineBoxes.dirtyLinesFromChangedChild(*this, child); }
160
161     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override final;
162     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override final;
163     
164     virtual void childBecameNonInline(RenderElement&) override final;
165
166     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&) override final;
167
168     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) override final;
169
170 #if ENABLE(DASHBOARD_SUPPORT)
171     virtual void addAnnotatedRegions(Vector<AnnotatedRegionValue>&) override final;
172 #endif
173     
174     RenderPtr<RenderInline> clone() const;
175
176     void paintOutlineForLine(GraphicsContext*, const LayoutPoint&, const LayoutRect& prevLine, const LayoutRect& thisLine,
177                              const LayoutRect& nextLine, const Color);
178     RenderBoxModelObject* continuationBefore(RenderObject* beforeChild);
179
180     RenderLineBoxList m_lineBoxes;   // All of the line boxes created for this inline flow.  For example, <i>Hello<br>world.</i> will have two <i> line boxes.
181 };
182
183 } // namespace WebCore
184
185 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderInline, isRenderInline())
186
187 #endif // RenderInline_h