946ccffb62e17c0dfc8f5fdca237c9c3340b300e
[WebKit-https.git] / Source / WebCore / rendering / line / LineWidth.h
1 /*
2  * Copyright (C) 2013 Adobe Systems Incorporated. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above
9  *    copyright notice, this list of conditions and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above
12  *    copyright notice, this list of conditions and the following
13  *    disclaimer in the documentation and/or other materials
14  *    provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
19  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
20  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27  * OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef LineWidth_h
31 #define LineWidth_h
32
33 #include "LayoutUnit.h"
34
35 namespace WebCore {
36
37 class FloatingObject;
38 class RenderBlockFlow;
39 class RenderObject;
40 class RenderRubyRun;
41 class RenderStyle;
42
43 struct LineSegment;
44
45 enum IndentTextOrNot { DoNotIndentText, IndentText };
46
47 class LineWidth {
48 public:
49     LineWidth(RenderBlockFlow&, bool isFirstLine, IndentTextOrNot shouldIndentText);
50
51     bool fitsOnLine(bool ignoringTrailingSpace = false) const;
52     bool fitsOnLineIncludingExtraWidth(float extra) const;
53     bool fitsOnLineExcludingTrailingWhitespace(float extra) const;
54
55     float currentWidth() const { return m_committedWidth + m_uncommittedWidth; }
56     // FIXME: We should eventually replace these three functions by ones that work on a higher abstraction.
57     float uncommittedWidth() const { return m_uncommittedWidth; }
58     float committedWidth() const { return m_committedWidth; }
59     float availableWidth() const { return m_availableWidth; }
60     float logicalLeftOffset() const { return m_left; }
61     
62     bool hasCommitted() const { return m_hasCommitted; }
63
64     void updateAvailableWidth(LayoutUnit minimumHeight = 0);
65     void shrinkAvailableWidthForNewFloatIfNeeded(const FloatingObject&);
66     void addUncommittedWidth(float delta)
67     {
68         m_uncommittedWidth += delta;
69     }
70     void commit();
71     void applyOverhang(RenderRubyRun*, RenderObject* startRenderer, RenderObject* endRenderer);
72     void fitBelowFloats(bool isFirstLine = false);
73     void setTrailingWhitespaceWidth(float collapsedWhitespace, float borderPaddingMargin = 0);
74     IndentTextOrNot shouldIndentText() const { return m_shouldIndentText; }
75     
76     bool isFirstLine() const { return m_isFirstLine; }
77
78 private:
79     void computeAvailableWidthFromLeftAndRight();
80     bool fitsOnLineExcludingTrailingCollapsedWhitespace() const;
81     void updateLineDimension(LayoutUnit newLineTop, LayoutUnit newLineWidth, float newLineLeft, float newLineRight);
82 #if ENABLE(CSS_SHAPES)
83     void wrapNextToShapeOutside(bool isFirstLine);
84 #endif
85
86     RenderBlockFlow& m_block;
87     float m_uncommittedWidth { 0 };
88     float m_committedWidth { 0 };
89     float m_overhangWidth { 0 }; // The amount by which |m_availableWidth| has been inflated to account for possible contraction due to ruby overhang.
90     float m_trailingWhitespaceWidth { 0 };
91     float m_trailingCollapsedWhitespaceWidth { 0 };
92     float m_left { 0 };
93     float m_right { 0 };
94     float m_availableWidth { 0 };
95     bool m_isFirstLine { true };
96     bool m_hasCommitted { false };
97     IndentTextOrNot m_shouldIndentText;
98 };
99
100 IndentTextOrNot requiresIndent(bool isFirstLine, bool isAfterHardLineBreak, const RenderStyle&);
101
102 }
103
104 #endif // LineWidth_h