[LCF][IFC] Add support for hyphenation.
[WebKit-https.git] / Source / WebCore / layout / inlineformatting / textlayout / TextContentProvider.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 "Runs.h"
31 #include <wtf/IsoMalloc.h>
32
33 namespace WebCore {
34
35 class FontCascade;
36 class RenderStyle;
37
38 namespace Layout {
39
40 class SimpleTextRunGenerator;
41
42 class TextContentProvider {
43     WTF_MAKE_ISO_ALLOCATED(TextContentProvider);
44 public:
45     TextContentProvider();
46     ~TextContentProvider();
47
48     void appendText(String, const RenderStyle&, bool canUseSimplifiedMeasure);
49     void appendLineBreak();
50
51     struct TextItem {
52         struct Style {
53             explicit Style(const RenderStyle&);
54
55             const FontCascade& font;
56             bool collapseWhitespace { false };
57             bool hasKerningOrLigatures { false };
58             float wordSpacing { 0 };
59             float tabWidth { 0 };
60             bool preserveNewline { false };
61             bool breakNBSP { false };
62             bool keepAllWordsForCJK { false };
63             AtomicString locale;
64         };
65
66         const String text;
67         const ContentPosition start { 0 };
68         const ContentPosition end { 0 };
69         const Style style;
70         const bool canUseSimplifiedMeasure { false };
71     };
72     using TextContent = Vector<TextItem>;
73     const TextContent& textContent() const { return m_textContent; }
74
75     using HardLineBreaks = Vector<ContentPosition>;
76     const HardLineBreaks& hardLineBreaks() const { return m_hardLineBreaks; }
77
78     unsigned length() const;
79     float width(ContentPosition from, ContentPosition to, float xPosition) const;
80     std::optional<ContentPosition> hyphenPositionBefore(ContentPosition from, ContentPosition to, ContentPosition before) const;
81
82     class Iterator {
83     public:
84         Iterator& operator++();
85         std::optional<TextRun> current() const { return m_contentProvider.current(); };
86
87     private:
88         friend class TextContentProvider;
89         Iterator(TextContentProvider&);
90
91         TextContentProvider& m_contentProvider;
92     };
93     Iterator iterator();
94
95     using TextRunList = Vector<TextRun>;
96     TextRunList textRuns();
97
98 private:
99     friend class Iterator;
100
101     const TextItem* findTextItemSlow(ContentPosition) const;
102     float textWidth(const TextItem&, ItemPosition from, ItemPosition to, float xPosition) const;
103     float fixedPitchWidth(String, const TextItem::Style&, ItemPosition from, ItemPosition to, float xPosition) const;
104
105     void findNextRun();
106     std::optional<TextRun> current() const;
107
108     TextContent m_textContent;
109     mutable ConstVectorIterator<TextItem> m_textContentIterator;
110     HardLineBreaks m_hardLineBreaks;
111     std::unique_ptr<SimpleTextRunGenerator> m_simpleTextRunGenerator;
112 };
113
114 inline TextContentProvider::Iterator::Iterator(TextContentProvider& contentProvider)
115     : m_contentProvider(contentProvider)
116 {
117 }
118
119 inline TextContentProvider::Iterator& TextContentProvider::Iterator::operator++()
120 {
121     m_contentProvider.findNextRun();
122     return *this;
123 }
124
125 }
126 }
127 #endif