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 "core/editing/PositionWithAffinity.h"
27#include "core/rendering/InlineFlowBox.h"
28#include "core/rendering/RenderBoxModelObject.h"
29#include "core/rendering/RenderLineBoxList.h"
30
31namespace blink {
32
33class RenderInline : public RenderBoxModelObject {
34public:
35    explicit RenderInline(Element*);
36    virtual void trace(Visitor*) OVERRIDE;
37
38    static RenderInline* createAnonymous(Document*);
39
40    RenderObject* firstChild() const { ASSERT(children() == virtualChildren()); return children()->firstChild(); }
41    RenderObject* lastChild() const { ASSERT(children() == virtualChildren()); return children()->lastChild(); }
42
43    // If you have a RenderInline, use firstChild or lastChild instead.
44    void slowFirstChild() const WTF_DELETED_FUNCTION;
45    void slowLastChild() const WTF_DELETED_FUNCTION;
46
47    virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) OVERRIDE;
48
49    Element* node() const { return toElement(RenderBoxModelObject::node()); }
50
51    virtual LayoutUnit marginLeft() const OVERRIDE FINAL;
52    virtual LayoutUnit marginRight() const OVERRIDE FINAL;
53    virtual LayoutUnit marginTop() const OVERRIDE FINAL;
54    virtual LayoutUnit marginBottom() const OVERRIDE FINAL;
55    virtual LayoutUnit marginBefore(const RenderStyle* otherStyle = 0) const OVERRIDE FINAL;
56    virtual LayoutUnit marginAfter(const RenderStyle* otherStyle = 0) const OVERRIDE FINAL;
57    virtual LayoutUnit marginStart(const RenderStyle* otherStyle = 0) const OVERRIDE FINAL;
58    virtual LayoutUnit marginEnd(const RenderStyle* otherStyle = 0) const OVERRIDE FINAL;
59
60    virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const OVERRIDE FINAL;
61    virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const OVERRIDE;
62
63    virtual LayoutSize offsetFromContainer(const RenderObject*, const LayoutPoint&, bool* offsetDependsOnPoint = 0) const OVERRIDE FINAL;
64
65    IntRect linesBoundingBox() const;
66    LayoutRect linesVisualOverflowBoundingBox() const;
67
68    InlineFlowBox* createAndAppendInlineFlowBox();
69
70    void dirtyLineBoxes(bool fullLayout);
71    void deleteLineBoxTree();
72
73    RenderLineBoxList* lineBoxes() { return &m_lineBoxes; }
74    const RenderLineBoxList* lineBoxes() const { return &m_lineBoxes; }
75
76    InlineFlowBox* firstLineBox() const { return m_lineBoxes.firstLineBox(); }
77    InlineFlowBox* lastLineBox() const { return m_lineBoxes.lastLineBox(); }
78    InlineBox* firstLineBoxIncludingCulling() const { return alwaysCreateLineBoxes() ? firstLineBox() : culledInlineFirstLineBox(); }
79    InlineBox* lastLineBoxIncludingCulling() const { return alwaysCreateLineBoxes() ? lastLineBox() : culledInlineLastLineBox(); }
80
81    virtual RenderBoxModelObject* virtualContinuation() const OVERRIDE FINAL { return continuation(); }
82    RenderInline* inlineElementContinuation() const;
83
84    virtual void updateDragState(bool dragOn) OVERRIDE FINAL;
85
86    LayoutSize offsetForInFlowPositionedInline(const RenderBox& child) const;
87
88    virtual void addFocusRingRects(Vector<LayoutRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer) const OVERRIDE FINAL;
89
90    using RenderBoxModelObject::continuation;
91    using RenderBoxModelObject::setContinuation;
92
93    bool alwaysCreateLineBoxes() const { return alwaysCreateLineBoxesForRenderInline(); }
94    void setAlwaysCreateLineBoxes(bool alwaysCreateLineBoxes = true) { setAlwaysCreateLineBoxesForRenderInline(alwaysCreateLineBoxes); }
95    void updateAlwaysCreateLineBoxes(bool fullLayout);
96
97    virtual LayoutRect localCaretRect(InlineBox*, int, LayoutUnit* extraWidthToEndOfLine) OVERRIDE FINAL;
98
99    bool hitTestCulledInline(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset);
100
101protected:
102    virtual void willBeDestroyed() OVERRIDE;
103
104    virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) OVERRIDE;
105
106    virtual void computeSelfHitTestRects(Vector<LayoutRect>& rects, const LayoutPoint& layerOffset) const OVERRIDE;
107
108private:
109    virtual RenderObjectChildList* virtualChildren() OVERRIDE FINAL { return children(); }
110    virtual const RenderObjectChildList* virtualChildren() const OVERRIDE FINAL { return children(); }
111    const RenderObjectChildList* children() const { return &m_children; }
112    RenderObjectChildList* children() { return &m_children; }
113
114    virtual const char* renderName() const OVERRIDE;
115
116    virtual bool isRenderInline() const OVERRIDE FINAL { return true; }
117
118    LayoutRect culledInlineVisualOverflowBoundingBox() const;
119    InlineBox* culledInlineFirstLineBox() const;
120    InlineBox* culledInlineLastLineBox() const;
121
122    template<typename GeneratorContext>
123    void generateLineBoxRects(GeneratorContext& yield) const;
124    template<typename GeneratorContext>
125    void generateCulledLineBoxRects(GeneratorContext& yield, const RenderInline* container) const;
126
127    void addChildToContinuation(RenderObject* newChild, RenderObject* beforeChild);
128    virtual void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild = 0) OVERRIDE FINAL;
129
130    void splitInlines(RenderBlock* fromBlock, RenderBlock* toBlock, RenderBlock* middleBlock,
131                      RenderObject* beforeChild, RenderBoxModelObject* oldCont);
132    void splitFlow(RenderObject* beforeChild, RenderBlock* newBlockBox,
133                   RenderObject* newChild, RenderBoxModelObject* oldCont);
134
135    virtual void layout() OVERRIDE FINAL { ASSERT_NOT_REACHED(); } // Do nothing for layout()
136
137    virtual void paint(PaintInfo&, const LayoutPoint&) OVERRIDE FINAL;
138
139    virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE FINAL;
140
141    virtual LayerType layerTypeRequired() const OVERRIDE { return isRelPositioned() || createsGroup() || hasClipPath() || style()->shouldCompositeForCurrentAnimations() ? NormalLayer : NoLayer; }
142
143    virtual LayoutUnit offsetLeft() const OVERRIDE FINAL;
144    virtual LayoutUnit offsetTop() const OVERRIDE FINAL;
145    virtual LayoutUnit offsetWidth() const OVERRIDE FINAL { return linesBoundingBox().width(); }
146    virtual LayoutUnit offsetHeight() const OVERRIDE FINAL { return linesBoundingBox().height(); }
147
148    virtual LayoutRect clippedOverflowRectForPaintInvalidation(const RenderLayerModelObject* paintInvalidationContainer, const PaintInvalidationState* = 0) const OVERRIDE;
149    virtual LayoutRect rectWithOutlineForPaintInvalidation(const RenderLayerModelObject* paintInvalidationContainer, LayoutUnit outlineWidth, const PaintInvalidationState* = 0) const OVERRIDE FINAL;
150    virtual void mapRectToPaintInvalidationBacking(const RenderLayerModelObject* paintInvalidationContainer, LayoutRect&, const PaintInvalidationState*) const OVERRIDE FINAL;
151
152    virtual void mapLocalToContainer(const RenderLayerModelObject* paintInvalidationContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0, const PaintInvalidationState* = 0) const OVERRIDE;
153
154    virtual PositionWithAffinity positionForPoint(const LayoutPoint&) OVERRIDE FINAL;
155
156    virtual IntRect borderBoundingBox() const OVERRIDE FINAL
157    {
158        IntRect boundingBox = linesBoundingBox();
159        return IntRect(0, 0, boundingBox.width(), boundingBox.height());
160    }
161
162    virtual InlineFlowBox* createInlineFlowBox(); // Subclassed by SVG and Ruby
163
164    virtual void dirtyLinesFromChangedChild(RenderObject* child) OVERRIDE FINAL { m_lineBoxes.dirtyLinesFromChangedChild(this, child); }
165
166    virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE FINAL;
167    virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE FINAL;
168
169    virtual void childBecameNonInline(RenderObject* child) OVERRIDE FINAL;
170
171    virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&) OVERRIDE FINAL;
172
173    virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) OVERRIDE FINAL;
174
175    virtual void addAnnotatedRegions(Vector<AnnotatedRegionValue>&) OVERRIDE FINAL;
176
177    virtual void updateFromStyle() OVERRIDE FINAL;
178
179    RenderInline* clone() const;
180
181    RenderBoxModelObject* continuationBefore(RenderObject* beforeChild);
182
183    RenderObjectChildList m_children;
184    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.
185};
186
187DEFINE_RENDER_OBJECT_TYPE_CASTS(RenderInline, isRenderInline());
188
189} // namespace blink
190
191#endif // RenderInline_h
192