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