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