Introduce RenderTreeBuilder
[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 #pragma once
24
25 #include "InlineFlowBox.h"
26 #include "RenderBoxModelObject.h"
27 #include "RenderLineBoxList.h"
28
29 namespace WebCore {
30
31 class Position;
32 class RenderFragmentContainer;
33
34 class RenderInline : public RenderBoxModelObject {
35     WTF_MAKE_ISO_ALLOCATED(RenderInline);
36 public:
37     RenderInline(Element&, RenderStyle&&);
38     RenderInline(Document&, RenderStyle&&);
39
40     void addChild(RenderTreeBuilder&, RenderPtr<RenderObject> newChild, RenderObject* beforeChild = 0) override;
41
42     LayoutUnit marginLeft() const final;
43     LayoutUnit marginRight() const final;
44     LayoutUnit marginTop() const final;
45     LayoutUnit marginBottom() const final;
46     LayoutUnit marginBefore(const RenderStyle* otherStyle = 0) const final;
47     LayoutUnit marginAfter(const RenderStyle* otherStyle = 0) const final;
48     LayoutUnit marginStart(const RenderStyle* otherStyle = 0) const final;
49     LayoutUnit marginEnd(const RenderStyle* otherStyle = 0) const final;
50
51     void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const final;
52     void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
53
54     LayoutSize offsetFromContainer(RenderElement&, const LayoutPoint&, bool* offsetDependsOnPoint = nullptr) const final;
55
56     LayoutRect borderBoundingBox() const final
57     {
58         return LayoutRect(LayoutPoint(), linesBoundingBox().size());
59     }
60
61     WEBCORE_EXPORT IntRect linesBoundingBox() const;
62     LayoutRect linesVisualOverflowBoundingBox() const;
63     LayoutRect linesVisualOverflowBoundingBoxInFragment(const RenderFragmentContainer*) const;
64
65     InlineFlowBox* createAndAppendInlineFlowBox();
66
67     void dirtyLineBoxes(bool fullLayout);
68     void deleteLines();
69
70     RenderLineBoxList& lineBoxes() { return m_lineBoxes; }
71     const RenderLineBoxList& lineBoxes() const { return m_lineBoxes; }
72
73     InlineFlowBox* firstLineBox() const { return m_lineBoxes.firstLineBox(); }
74     InlineFlowBox* lastLineBox() const { return m_lineBoxes.lastLineBox(); }
75     InlineBox* firstLineBoxIncludingCulling() const { return alwaysCreateLineBoxes() ? firstLineBox() : culledInlineFirstLineBox(); }
76     InlineBox* lastLineBoxIncludingCulling() const { return alwaysCreateLineBoxes() ? lastLineBox() : culledInlineLastLineBox(); }
77
78 #if PLATFORM(IOS)
79     void absoluteQuadsForSelection(Vector<FloatQuad>& quads) const override;
80 #endif
81
82     void updateDragState(bool dragOn) final;
83     
84     LayoutSize offsetForInFlowPositionedInline(const RenderBox* child) const;
85
86     void addFocusRingRects(Vector<LayoutRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer = 0) final;
87     void paintOutline(PaintInfo&, const LayoutPoint&);
88
89     bool alwaysCreateLineBoxes() const { return renderInlineAlwaysCreatesLineBoxes(); }
90     void setAlwaysCreateLineBoxes() { setRenderInlineAlwaysCreatesLineBoxes(true); }
91     void updateAlwaysCreateLineBoxes(bool fullLayout);
92
93     LayoutRect localCaretRect(InlineBox*, unsigned, LayoutUnit* extraWidthToEndOfLine) final;
94
95     bool hitTestCulledInline(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset);
96
97 protected:
98     void willBeDestroyed() override;
99
100     void styleWillChange(StyleDifference, const RenderStyle& newStyle) override;
101     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
102
103     void updateFromStyle() override;
104
105 private:
106     const char* renderName() const override;
107
108     bool canHaveChildren() const final { return true; }
109
110     LayoutRect culledInlineVisualOverflowBoundingBox() const;
111     InlineBox* culledInlineFirstLineBox() const;
112     InlineBox* culledInlineLastLineBox() const;
113
114     template<typename GeneratorContext>
115     void generateLineBoxRects(GeneratorContext& yield) const;
116     template<typename GeneratorContext>
117     void generateCulledLineBoxRects(GeneratorContext& yield, const RenderInline* container) const;
118
119     void addChildToContinuation(RenderTreeBuilder&, RenderPtr<RenderObject> newChild, RenderObject* beforeChild);
120     void addChildIgnoringContinuation(RenderTreeBuilder&, RenderPtr<RenderObject> newChild, RenderObject* beforeChild = nullptr) final;
121
122     void splitInlines(RenderTreeBuilder&, RenderBlock* fromBlock, RenderBlock* toBlock, RenderBlock* middleBlock, RenderObject* beforeChild, RenderBoxModelObject* oldCont);
123     void splitFlow(RenderTreeBuilder&, RenderObject* beforeChild, RenderPtr<RenderBlock> newBlockBox, RenderPtr<RenderObject> newChild, RenderBoxModelObject* oldCont);
124
125     void layout() final { ASSERT_NOT_REACHED(); } // Do nothing for layout()
126
127     void paint(PaintInfo&, const LayoutPoint&) final;
128
129     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) final;
130
131     bool requiresLayer() const override { return isInFlowPositioned() || createsGroup() || hasClipPath() || willChangeCreatesStackingContext(); }
132
133     LayoutUnit offsetLeft() const final;
134     LayoutUnit offsetTop() const final;
135     LayoutUnit offsetWidth() const final { return linesBoundingBox().width(); }
136     LayoutUnit offsetHeight() const final { return linesBoundingBox().height(); }
137
138     LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override;
139     LayoutRect rectWithOutlineForRepaint(const RenderLayerModelObject* repaintContainer, LayoutUnit outlineWidth) const final;
140     LayoutRect computeRectForRepaint(const LayoutRect&, const RenderLayerModelObject* repaintContainer, RepaintContext = { }) const final;
141
142     void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
143     const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
144
145     VisiblePosition positionForPoint(const LayoutPoint&, const RenderFragmentContainer*) final;
146
147     LayoutRect frameRectForStickyPositioning() const final { return linesBoundingBox(); }
148
149     virtual std::unique_ptr<InlineFlowBox> createInlineFlowBox(); // Subclassed by RenderSVGInline
150
151     void dirtyLinesFromChangedChild(RenderObject& child) final { m_lineBoxes.dirtyLinesFromChangedChild(*this, child); }
152
153     LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const final;
154     int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const final;
155     
156     void childBecameNonInline(RenderElement&) final;
157
158     void updateHitTestResult(HitTestResult&, const LayoutPoint&) final;
159
160     void imageChanged(WrappedImagePtr, const IntRect* = 0) final;
161
162 #if ENABLE(DASHBOARD_SUPPORT)
163     void addAnnotatedRegions(Vector<AnnotatedRegionValue>&) final;
164 #endif
165     
166     RenderPtr<RenderInline> cloneAsContinuation() const;
167
168     void paintOutlineForLine(GraphicsContext&, const LayoutPoint&, const LayoutRect& prevLine, const LayoutRect& thisLine, const LayoutRect& nextLine, const Color&);
169     RenderBoxModelObject* continuationBefore(RenderObject* beforeChild);
170
171     bool willChangeCreatesStackingContext() const
172     {
173         return style().willChange() && style().willChange()->canCreateStackingContext();
174     }
175
176     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.
177 };
178
179 } // namespace WebCore
180
181 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderInline, isRenderInline())