[LCF][IFC] Add support for hyphenation.
[WebKit-https.git] / Source / WebCore / layout / inlineformatting / textlayout / Runs.h
1 /*
2  * Copyright (C) 2018 Apple Inc. 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
29
30 #include "TextFlags.h"
31
32 namespace WebCore {
33 namespace Layout {
34
35 using ContentPosition = unsigned;
36 using ItemPosition = unsigned;
37
38 struct TextRun {
39 public:
40     enum class Type {
41         Whitespace,
42         NonWhitespace,
43         SoftLineBreak,
44         HardLineBreak,
45         Invalid
46     };
47     static TextRun createWhitespaceRun(ContentPosition start, ContentPosition end, float width, bool isCollapsed);
48     static TextRun createNonWhitespaceRun(ContentPosition start, ContentPosition end, float width);
49     static TextRun createNonWhitespaceRunWithHyphen(ContentPosition start, ContentPosition end, float width);
50     static TextRun createSoftLineBreakRun(ContentPosition);
51     static TextRun createHardLineBreakRun(ContentPosition);
52
53     TextRun() = default;
54     TextRun(ContentPosition start, ContentPosition end, Type, float width = 0, bool isCollapsed = false, bool hasHyphen = false);
55
56     ContentPosition start() const;
57     ContentPosition end() const;
58     unsigned length() const;
59
60     float width() const;
61
62     bool isWhitespace() const { return m_type == Type::Whitespace; }
63     bool isNonWhitespace() const { return m_type == Type::NonWhitespace; }
64     bool isLineBreak() const { return isSoftLineBreak() || isHardLineBreak(); }
65     bool isSoftLineBreak() const { return m_type == Type::SoftLineBreak; }
66     bool isHardLineBreak() const { return m_type == Type::HardLineBreak; }
67     bool isValid() const { return m_type != Type::Invalid; }
68     bool isCollapsed() const { return m_isCollapsed; }
69     Type type() const { return m_type; }
70
71     void setIsCollapsed(bool isCollapsed) { m_isCollapsed = isCollapsed; }
72     bool hasHyphen() const { return m_hasHyphen; }
73     void setWidth(float width) { m_width = width; }
74
75 private:
76     ContentPosition m_start { 0 };
77     ContentPosition m_end { 0 };
78     Type m_type { Type::Invalid };
79     float m_width { 0 };
80     bool m_isCollapsed { false };
81     bool m_hasHyphen { false };
82 };
83
84 struct LayoutRun {
85 public:
86     LayoutRun(ContentPosition start, ContentPosition end, float left, float right, bool hasHyphen);
87
88     ContentPosition start() const { return m_start; }
89     ContentPosition end() const { return m_end; }
90     unsigned length() const { return end() - start(); }
91
92     float left() const { return m_left; }
93     float right() const { return m_right; }
94     float width() const { return right() - left(); }
95
96     bool isEndOfLine() const { return m_isEndOfLine; }
97
98     void setEnd(ContentPosition end) { m_end = end; }
99     void setLeft(float left) { m_left = left; }
100     void setRight(float right) { m_right = right; }
101     void setIsEndOfLine() { m_isEndOfLine = true; }
102
103     void setExpansion(ExpansionBehavior, float expansion);
104     void setHasHyphen() { m_hasHyphen = true; }
105     bool hasHyphen() const { return m_hasHyphen; }
106
107 private:
108     ContentPosition m_start { 0 };
109     ContentPosition m_end { 0 };
110     float m_left { 0 };
111     float m_right { 0 };
112     bool m_isEndOfLine { false };
113     bool m_hasHyphen { false };
114     float m_expansion { 0 };
115     ExpansionBehavior m_expansionBehavior { ForbidLeadingExpansion | ForbidTrailingExpansion };
116 };
117
118 template<typename T>
119 class ConstVectorIterator {
120 public:
121     ConstVectorIterator(const Vector<T>&);
122
123     const T* current() const;
124     ConstVectorIterator<T>& operator++();
125     void reset() { m_index = 0; }
126
127 private:
128     const Vector<T>& m_content;
129     unsigned m_index { 0 };
130 };
131
132 template<typename T>
133 inline ConstVectorIterator<T>::ConstVectorIterator(const Vector<T>& content)
134     : m_content(content)
135 {
136 }
137
138 template<typename T>
139 inline const T* ConstVectorIterator<T>::current() const
140 {
141     if (m_index == m_content.size())
142         return nullptr;
143     return &m_content[m_index];
144 }
145
146 template<typename T>
147 inline ConstVectorIterator<T>& ConstVectorIterator<T>::operator++()
148 {
149     ++m_index;
150     return *this;
151 }
152
153 inline LayoutRun::LayoutRun(ContentPosition start, ContentPosition end, float left, float right, bool hasHyphen)
154     : m_start(start)
155     , m_end(end)
156     , m_left(left)
157     , m_right(right)
158     , m_hasHyphen(hasHyphen)
159 {
160 }
161
162 inline void LayoutRun::setExpansion(ExpansionBehavior expansionBehavior, float expansion)
163 {
164     m_expansionBehavior = expansionBehavior;
165     m_expansion = expansion;
166 }
167
168 inline TextRun TextRun::createWhitespaceRun(ContentPosition start, ContentPosition end, float width, bool isCollapsed)
169 {
170     return { start, end, Type::Whitespace, width, isCollapsed };
171 }
172
173 inline TextRun TextRun::createNonWhitespaceRun(ContentPosition start, ContentPosition end, float width)
174 {
175     return { start, end, Type::NonWhitespace, width };
176 }
177
178 inline TextRun TextRun::createNonWhitespaceRunWithHyphen(ContentPosition start, ContentPosition end, float width)
179 {
180     return { start, end, Type::NonWhitespace, width, false, true };
181 }
182
183 inline TextRun TextRun::createSoftLineBreakRun(ContentPosition position)
184 {
185     return { position, position + 1, Type::SoftLineBreak };
186 }
187
188 inline TextRun TextRun::createHardLineBreakRun(ContentPosition position)
189 {
190     return { position, position, Type::HardLineBreak };
191 }
192
193 inline TextRun::TextRun(ContentPosition start, ContentPosition end, Type type, float width, bool isCollapsed, bool hasHyphen)
194     : m_start(start)
195     , m_end(end)
196     , m_type(type)
197     , m_width(width)
198     , m_isCollapsed(isCollapsed)
199     , m_hasHyphen(hasHyphen)
200 {
201 }
202
203 inline ContentPosition TextRun::start() const
204 {
205     ASSERT(type() != Type::Invalid);
206     return m_start;
207 }
208
209 inline ContentPosition TextRun::end() const
210 {
211     ASSERT(type() != Type::Invalid);
212     return m_end;
213 }
214
215 inline unsigned TextRun::length() const
216 {
217     ASSERT(type() != Type::Invalid);
218     return m_end - m_start;
219 }
220
221 inline float TextRun::width() const
222 {
223     ASSERT(type() != Type::Invalid);
224     return m_width;
225 }
226
227 }
228 }
229 #endif