blob: 1dd0a2f1c0b4d2d60200be0df55904cc5d79dba6 [file] [log] [blame]
Ben Wagnera25fbef2017-08-30 13:56:19 -04001/*
2 * Copyright 2016 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
Ben Wagner2fc14742019-02-06 16:37:44 -05008#include "SkBitmaskEnum.h"
Hal Canary61021922019-02-06 12:29:11 -05009#include "SkFont.h"
Ben Wagner17774242018-08-07 14:31:33 -040010#include "SkFontArguments.h"
Hal Canary61021922019-02-06 12:29:11 -050011#include "SkFontMetrics.h"
Ben Wagner67e3a302017-09-05 14:46:19 -040012#include "SkFontMgr.h"
Ben Wagnerb0591942019-02-15 14:46:18 -050013#include "SkMakeUnique.h"
Ben Wagner17774242018-08-07 14:31:33 -040014#include "SkMalloc.h"
Ben Wagner17774242018-08-07 14:31:33 -040015#include "SkPoint.h"
16#include "SkRefCnt.h"
17#include "SkScalar.h"
Ben Wagnera25fbef2017-08-30 13:56:19 -040018#include "SkShaper.h"
19#include "SkStream.h"
Ben Wagner17774242018-08-07 14:31:33 -040020#include "SkString.h"
21#include "SkTArray.h"
Ben Wagner8d45a382017-11-16 10:08:28 -050022#include "SkTDPQueue.h"
Ben Wagner17774242018-08-07 14:31:33 -040023#include "SkTFitsIn.h"
Ben Wagner8d45a382017-11-16 10:08:28 -050024#include "SkTLazy.h"
Ben Wagnere0001732017-08-31 16:26:26 -040025#include "SkTemplates.h"
Hal Canaryc640d0d2018-06-13 09:59:02 -040026#include "SkTo.h"
Ben Wagnera25fbef2017-08-30 13:56:19 -040027#include "SkTypeface.h"
Ben Wagner17774242018-08-07 14:31:33 -040028#include "SkTypes.h"
29#include "SkUTF.h"
30
31#include <hb.h>
32#include <hb-ot.h>
Ben Wagnerc5aa8eb2019-01-24 16:15:55 -050033#include <unicode/ubrk.h>
Ben Wagner17774242018-08-07 14:31:33 -040034#include <unicode/ubidi.h>
Ben Wagnerc5aa8eb2019-01-24 16:15:55 -050035#include <unicode/ustring.h>
Ben Wagner17774242018-08-07 14:31:33 -040036#include <unicode/urename.h>
37#include <unicode/utext.h>
38#include <unicode/utypes.h>
39
Ben Wagner0ec8ec22018-09-04 18:17:13 -040040#include <cstring>
41#include <locale>
Ben Wagner17774242018-08-07 14:31:33 -040042#include <memory>
43#include <utility>
Ben Wagnera25fbef2017-08-30 13:56:19 -040044
Hal Canary61021922019-02-06 12:29:11 -050045#if defined(SK_USING_THIRD_PARTY_ICU)
Hal Canary32498f02019-02-04 15:36:31 -050046#include "SkLoadICU.h"
Hal Canary61021922019-02-06 12:29:11 -050047#endif
Hal Canary32498f02019-02-04 15:36:31 -050048
Ben Wagner2fc14742019-02-06 16:37:44 -050049namespace skstd {
50template <> struct is_bitmask_enum<hb_buffer_flags_t> : std::true_type {};
51}
52
Ben Wagnera25fbef2017-08-30 13:56:19 -040053namespace {
54template <class T, void(*P)(T*)> using resource = std::unique_ptr<T, SkFunctionWrapper<void, T, P>>;
Ben Wagnerc5aa8eb2019-01-24 16:15:55 -050055using HBBlob = resource<hb_blob_t , hb_blob_destroy >;
56using HBFace = resource<hb_face_t , hb_face_destroy >;
57using HBFont = resource<hb_font_t , hb_font_destroy >;
58using HBBuffer = resource<hb_buffer_t , hb_buffer_destroy>;
59using ICUBiDi = resource<UBiDi , ubidi_close >;
Ben Wagner0ec8ec22018-09-04 18:17:13 -040060using ICUBrk = resource<UBreakIterator, ubrk_close >;
Ben Wagnera25fbef2017-08-30 13:56:19 -040061
62HBBlob stream_to_blob(std::unique_ptr<SkStreamAsset> asset) {
63 size_t size = asset->getLength();
64 HBBlob blob;
65 if (const void* base = asset->getMemoryBase()) {
66 blob.reset(hb_blob_create((char*)base, SkToUInt(size),
67 HB_MEMORY_MODE_READONLY, asset.release(),
68 [](void* p) { delete (SkStreamAsset*)p; }));
69 } else {
70 // SkDebugf("Extra SkStreamAsset copy\n");
71 void* ptr = size ? sk_malloc_throw(size) : nullptr;
72 asset->read(ptr, size);
73 blob.reset(hb_blob_create((char*)ptr, SkToUInt(size),
74 HB_MEMORY_MODE_READONLY, ptr, sk_free));
75 }
76 SkASSERT(blob);
77 hb_blob_make_immutable(blob.get());
78 return blob;
79}
Ben Wagnera25fbef2017-08-30 13:56:19 -040080
Ben Wagnerf61c9362019-02-13 12:01:45 -050081hb_position_t skhb_position(SkScalar value) {
82 // Treat HarfBuzz hb_position_t as 16.16 fixed-point.
83 constexpr int kHbPosition1 = 1 << 16;
84 return SkScalarRoundToInt(value * kHbPosition1);
85}
86
87hb_bool_t skhb_glyph(hb_font_t* hb_font,
88 void* font_data,
89 hb_codepoint_t unicode,
90 hb_codepoint_t variation_selector,
91 hb_codepoint_t* glyph,
92 void* user_data) {
93 SkFont& font = *reinterpret_cast<SkFont*>(font_data);
94
95 *glyph = font.unicharToGlyph(unicode);
96 return *glyph != 0;
97}
98
99hb_bool_t skhb_nominal_glyph(hb_font_t* hb_font,
100 void* font_data,
101 hb_codepoint_t unicode,
102 hb_codepoint_t* glyph,
103 void* user_data) {
104 return skhb_glyph(hb_font, font_data, unicode, 0, glyph, user_data);
105}
106
107unsigned skhb_nominal_glyphs(hb_font_t *hb_font, void *font_data,
108 unsigned int count,
109 const hb_codepoint_t *unicodes,
110 unsigned int unicode_stride,
111 hb_codepoint_t *glyphs,
112 unsigned int glyph_stride,
113 void *user_data) {
114 SkFont& font = *reinterpret_cast<SkFont*>(font_data);
115
116 // Batch call textToGlyphs since entry cost is not cheap.
117 // Copy requred because textToGlyphs is dense and hb is strided.
118 SkAutoSTMalloc<256, SkUnichar> unicode(count);
119 for (unsigned i = 0; i < count; i++) {
120 unicode[i] = *unicodes;
121 unicodes = SkTAddOffset<const hb_codepoint_t>(unicodes, unicode_stride);
122 }
123 SkAutoSTMalloc<256, SkGlyphID> glyph(count);
124 font.textToGlyphs(unicode.get(), count * sizeof(SkUnichar), kUTF32_SkTextEncoding,
125 glyph.get(), count);
126
127 // Copy the results back to the sparse array.
128 for (unsigned i = 0; i < count; i++) {
129 *glyphs = glyph[i];
130 glyphs = SkTAddOffset<hb_codepoint_t>(glyphs, glyph_stride);
131 }
132 // TODO: supposed to return index of first 0?
133 return count;
134}
135
136hb_position_t skhb_glyph_h_advance(hb_font_t* hb_font,
137 void* font_data,
138 hb_codepoint_t codepoint,
139 void* user_data) {
140 SkFont& font = *reinterpret_cast<SkFont*>(font_data);
141
142 SkScalar advance;
143 SkGlyphID glyph = SkTo<SkGlyphID>(codepoint);
144
145 font.getWidths(&glyph, 1, &advance);
146 if (!font.isSubpixel()) {
147 advance = SkScalarRoundToInt(advance);
148 }
149 return skhb_position(advance);
150}
151
152void skhb_glyph_h_advances(hb_font_t* hb_font,
153 void* font_data,
154 unsigned count,
155 const hb_codepoint_t* glyphs,
156 unsigned int glyph_stride,
157 hb_position_t* advances,
158 unsigned int advance_stride,
159 void* user_data) {
160 SkFont& font = *reinterpret_cast<SkFont*>(font_data);
161
162 // Batch call getWidths since entry cost is not cheap.
163 // Copy requred because getWidths is dense and hb is strided.
164 SkAutoSTMalloc<256, SkGlyphID> glyph(count);
165 for (unsigned i = 0; i < count; i++) {
166 glyph[i] = *glyphs;
167 glyphs = SkTAddOffset<const hb_codepoint_t>(glyphs, glyph_stride);
168 }
169 SkAutoSTMalloc<256, SkScalar> advance(count);
170 font.getWidths(glyph.get(), count, advance.get());
171
172 if (!font.isSubpixel()) {
173 for (unsigned i = 0; i < count; i++) {
174 advance[i] = SkScalarRoundToInt(advance[i]);
175 }
176 }
177
178 // Copy the results back to the sparse array.
179 for (unsigned i = 0; i < count; i++) {
180 *advances = skhb_position(advance[i]);
181 advances = SkTAddOffset<hb_position_t>(advances, advance_stride);
182 }
183}
184
185// HarfBuzz callback to retrieve glyph extents, mainly used by HarfBuzz for
186// fallback mark positioning, i.e. the situation when the font does not have
187// mark anchors or other mark positioning rules, but instead HarfBuzz is
188// supposed to heuristically place combining marks around base glyphs. HarfBuzz
189// does this by measuring "ink boxes" of glyphs, and placing them according to
190// Unicode mark classes. Above, below, centered or left or right, etc.
191hb_bool_t skhb_glyph_extents(hb_font_t* hb_font,
192 void* font_data,
193 hb_codepoint_t codepoint,
194 hb_glyph_extents_t* extents,
195 void* user_data) {
196 SkFont& font = *reinterpret_cast<SkFont*>(font_data);
197
198 SkASSERT(codepoint < 0xFFFFu);
199 SkASSERT(extents);
200
201 SkRect sk_bounds;
202 SkGlyphID glyph = codepoint;
203
204 font.getWidths(&glyph, 1, nullptr, &sk_bounds);
205 if (!font.isSubpixel()) {
206 sk_bounds.set(sk_bounds.roundOut());
207 }
208
209 // Skia is y-down but HarfBuzz is y-up.
210 extents->x_bearing = skhb_position(sk_bounds.fLeft);
211 extents->y_bearing = skhb_position(-sk_bounds.fTop);
212 extents->width = skhb_position(sk_bounds.width());
213 extents->height = skhb_position(-sk_bounds.height());
214 return true;
215}
216
Kevin Lubick867da4b2019-02-22 15:55:39 -0500217#define SK_HB_VERSION_CHECK(x, y, z) \
218 (HB_VERSION_MAJOR > (x)) || \
219 (HB_VERSION_MAJOR == (x) && HB_VERSION_MINOR > (y)) || \
220 (HB_VERSION_MAJOR == (x) && HB_VERSION_MINOR == (y) && HB_VERSION_MICRO >= (z))
221
Ben Wagnerf61c9362019-02-13 12:01:45 -0500222hb_font_funcs_t* skhb_get_font_funcs() {
223 static hb_font_funcs_t* const funcs = []{
224 // HarfBuzz will use the default (parent) implementation if they aren't set.
225 hb_font_funcs_t* const funcs = hb_font_funcs_create();
226 hb_font_funcs_set_variation_glyph_func(funcs, skhb_glyph, nullptr, nullptr);
227 hb_font_funcs_set_nominal_glyph_func(funcs, skhb_nominal_glyph, nullptr, nullptr);
Kevin Lubick867da4b2019-02-22 15:55:39 -0500228#if SK_HB_VERSION_CHECK(2, 0, 0)
Ben Wagnerf61c9362019-02-13 12:01:45 -0500229 hb_font_funcs_set_nominal_glyphs_func(funcs, skhb_nominal_glyphs, nullptr, nullptr);
Kevin Lubick867da4b2019-02-22 15:55:39 -0500230#else
231 sk_ignore_unused_variable(skhb_nominal_glyphs);
232#endif
Ben Wagnerf61c9362019-02-13 12:01:45 -0500233 hb_font_funcs_set_glyph_h_advance_func(funcs, skhb_glyph_h_advance, nullptr, nullptr);
Kevin Lubick867da4b2019-02-22 15:55:39 -0500234#if SK_HB_VERSION_CHECK(1, 8, 6)
Ben Wagnerf61c9362019-02-13 12:01:45 -0500235 hb_font_funcs_set_glyph_h_advances_func(funcs, skhb_glyph_h_advances, nullptr, nullptr);
Kevin Lubick867da4b2019-02-22 15:55:39 -0500236#else
237 sk_ignore_unused_variable(skhb_glyph_h_advances);
238#endif
Ben Wagnerf61c9362019-02-13 12:01:45 -0500239 hb_font_funcs_set_glyph_extents_func(funcs, skhb_glyph_extents, nullptr, nullptr);
240 hb_font_funcs_make_immutable(funcs);
241 return funcs;
242 }();
243 SkASSERT(funcs);
244 return funcs;
245}
246
247hb_blob_t* skhb_get_table(hb_face_t* face, hb_tag_t tag, void* user_data) {
248 SkTypeface& typeface = *reinterpret_cast<SkTypeface*>(user_data);
249
250 const size_t tableSize = typeface.getTableSize(tag);
251 if (!tableSize) {
Hal Canary0dfa2082018-10-31 13:02:49 -0400252 return nullptr;
253 }
Ben Wagnerf61c9362019-02-13 12:01:45 -0500254
255 void* buffer = sk_malloc_throw(tableSize);
256 if (!buffer) {
257 return nullptr;
258 }
259
260 size_t actualSize = typeface.getTableData(tag, 0, tableSize, buffer);
261 if (tableSize != actualSize) {
262 sk_free(buffer);
263 return nullptr;
264 }
265
266 return hb_blob_create(reinterpret_cast<char*>(buffer), tableSize,
267 HB_MEMORY_MODE_WRITABLE, buffer, sk_free);
268}
269
270HBFont create_hb_font(const SkFont& font) {
Ben Wagnera25fbef2017-08-30 13:56:19 -0400271 int index;
Ben Wagnerff84d8a2019-02-26 15:39:41 -0500272 std::unique_ptr<SkStreamAsset> typefaceAsset = font.getTypeface()->openStream(&index);
Ben Wagnerf61c9362019-02-13 12:01:45 -0500273 HBFace face;
Hal Canaryddef43f2018-11-16 10:53:51 -0500274 if (!typefaceAsset) {
Ben Wagnerf61c9362019-02-13 12:01:45 -0500275 face.reset(hb_face_create_for_tables(
276 skhb_get_table,
277 reinterpret_cast<void *>(font.refTypeface().release()),
278 [](void* user_data){ SkSafeUnref(reinterpret_cast<SkTypeface*>(user_data)); }));
279 } else {
280 HBBlob blob(stream_to_blob(std::move(typefaceAsset)));
281 face.reset(hb_face_create(blob.get(), (unsigned)index));
Hal Canaryddef43f2018-11-16 10:53:51 -0500282 }
Ben Wagnera25fbef2017-08-30 13:56:19 -0400283 SkASSERT(face);
284 if (!face) {
Ben Wagnere0001732017-08-31 16:26:26 -0400285 return nullptr;
Ben Wagnera25fbef2017-08-30 13:56:19 -0400286 }
287 hb_face_set_index(face.get(), (unsigned)index);
Ben Wagnerf61c9362019-02-13 12:01:45 -0500288 hb_face_set_upem(face.get(), font.getTypeface()->getUnitsPerEm());
Ben Wagnera25fbef2017-08-30 13:56:19 -0400289
Ben Wagnerf61c9362019-02-13 12:01:45 -0500290 HBFont otFont(hb_font_create(face.get()));
291 SkASSERT(otFont);
292 if (!otFont) {
Ben Wagnere0001732017-08-31 16:26:26 -0400293 return nullptr;
294 }
Ben Wagnerf61c9362019-02-13 12:01:45 -0500295 hb_ot_font_set_funcs(otFont.get());
296 int axis_count = font.getTypeface()->getVariationDesignPosition(nullptr, 0);
Ben Wagnere0001732017-08-31 16:26:26 -0400297 if (axis_count > 0) {
298 SkAutoSTMalloc<4, SkFontArguments::VariationPosition::Coordinate> axis_values(axis_count);
Ben Wagnerf61c9362019-02-13 12:01:45 -0500299 if (font.getTypeface()->getVariationDesignPosition(axis_values, axis_count) == axis_count) {
300 hb_font_set_variations(otFont.get(),
Ben Wagnere0001732017-08-31 16:26:26 -0400301 reinterpret_cast<hb_variation_t*>(axis_values.get()),
302 axis_count);
303 }
304 }
Ben Wagnerf61c9362019-02-13 12:01:45 -0500305
306 // Creating a sub font means that non-available functions
307 // are found from the parent.
308 HBFont skFont(hb_font_create_sub_font(otFont.get()));
309 hb_font_set_funcs(skFont.get(), skhb_get_font_funcs(),
310 reinterpret_cast<void *>(new SkFont(font)),
311 [](void* user_data){ delete reinterpret_cast<SkFont*>(user_data); });
312 int scale = skhb_position(font.getSize());
313 hb_font_set_scale(skFont.get(), scale, scale);
314
315 return skFont;
Ben Wagnere0001732017-08-31 16:26:26 -0400316}
317
Hal Canaryf107a2f2018-07-25 16:52:48 -0400318/** this version replaces invalid utf-8 sequences with code point U+FFFD. */
319static inline SkUnichar utf8_next(const char** ptr, const char* end) {
320 SkUnichar val = SkUTF::NextUTF8(ptr, end);
321 if (val < 0) {
322 return 0xFFFD; // REPLACEMENT CHARACTER
323 }
324 return val;
325}
326
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400327class IcuBiDiRunIterator final : public SkShaper::BiDiRunIterator {
Ben Wagner8d45a382017-11-16 10:08:28 -0500328public:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400329 static SkTLazy<IcuBiDiRunIterator> Make(const char* utf8, size_t utf8Bytes, UBiDiLevel level) {
330 SkTLazy<IcuBiDiRunIterator> ret;
Ben Wagner8d45a382017-11-16 10:08:28 -0500331
332 // ubidi only accepts utf16 (though internally it basically works on utf32 chars).
333 // We want an ubidi_setPara(UBiDi*, UText*, UBiDiLevel, UBiDiLevel*, UErrorCode*);
334 if (!SkTFitsIn<int32_t>(utf8Bytes)) {
335 SkDebugf("Bidi error: text too long");
336 return ret;
337 }
Ben Wagner8d45a382017-11-16 10:08:28 -0500338
339 UErrorCode status = U_ZERO_ERROR;
Ben Wagnerc5aa8eb2019-01-24 16:15:55 -0500340
341 // Getting the length like this seems to always set U_BUFFER_OVERFLOW_ERROR
342 int32_t utf16Units;
343 u_strFromUTF8(nullptr, 0, &utf16Units, utf8, utf8Bytes, &status);
344 status = U_ZERO_ERROR;
345 std::unique_ptr<UChar[]> utf16(new UChar[utf16Units]);
346 u_strFromUTF8(utf16.get(), utf16Units, nullptr, utf8, utf8Bytes, &status);
347 if (U_FAILURE(status)) {
348 SkDebugf("Invalid utf8 input: %s", u_errorName(status));
349 return ret;
350 }
351
352 ICUBiDi bidi(ubidi_openSized(utf16Units, 0, &status));
Ben Wagner8d45a382017-11-16 10:08:28 -0500353 if (U_FAILURE(status)) {
354 SkDebugf("Bidi error: %s", u_errorName(status));
355 return ret;
356 }
357 SkASSERT(bidi);
358
359 // The required lifetime of utf16 isn't well documented.
360 // It appears it isn't used after ubidi_setPara except through ubidi_getText.
Ben Wagnerc5aa8eb2019-01-24 16:15:55 -0500361 ubidi_setPara(bidi.get(), utf16.get(), utf16Units, level, nullptr, &status);
Ben Wagner8d45a382017-11-16 10:08:28 -0500362 if (U_FAILURE(status)) {
363 SkDebugf("Bidi error: %s", u_errorName(status));
364 return ret;
365 }
366
Hal Canary4014ba62018-07-24 11:33:21 -0400367 ret.init(utf8, utf8 + utf8Bytes, std::move(bidi));
Ben Wagner8d45a382017-11-16 10:08:28 -0500368 return ret;
369 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400370 IcuBiDiRunIterator(const char* utf8, const char* end, ICUBiDi bidi)
Ben Wagner8d45a382017-11-16 10:08:28 -0500371 : fBidi(std::move(bidi))
372 , fEndOfCurrentRun(utf8)
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400373 , fBegin(utf8)
374 , fEnd(end)
Ben Wagner8d45a382017-11-16 10:08:28 -0500375 , fUTF16LogicalPosition(0)
376 , fLevel(UBIDI_DEFAULT_LTR)
377 {}
378 void consume() override {
379 SkASSERT(fUTF16LogicalPosition < ubidi_getLength(fBidi.get()));
380 int32_t endPosition = ubidi_getLength(fBidi.get());
381 fLevel = ubidi_getLevelAt(fBidi.get(), fUTF16LogicalPosition);
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400382 SkUnichar u = utf8_next(&fEndOfCurrentRun, fEnd);
Hal Canaryf107a2f2018-07-25 16:52:48 -0400383 fUTF16LogicalPosition += SkUTF::ToUTF16(u);
Ben Wagner8d45a382017-11-16 10:08:28 -0500384 UBiDiLevel level;
385 while (fUTF16LogicalPosition < endPosition) {
386 level = ubidi_getLevelAt(fBidi.get(), fUTF16LogicalPosition);
387 if (level != fLevel) {
388 break;
389 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400390 u = utf8_next(&fEndOfCurrentRun, fEnd);
Hal Canaryf107a2f2018-07-25 16:52:48 -0400391 fUTF16LogicalPosition += SkUTF::ToUTF16(u);
Ben Wagner8d45a382017-11-16 10:08:28 -0500392 }
393 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400394 size_t endOfCurrentRun() const override {
395 return fEndOfCurrentRun - fBegin;
Ben Wagner8d45a382017-11-16 10:08:28 -0500396 }
397 bool atEnd() const override {
398 return fUTF16LogicalPosition == ubidi_getLength(fBidi.get());
399 }
400
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400401 UBiDiLevel currentLevel() const override {
Ben Wagner8d45a382017-11-16 10:08:28 -0500402 return fLevel;
403 }
404private:
405 ICUBiDi fBidi;
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400406 char const * fEndOfCurrentRun;
407 char const * const fBegin;
408 char const * const fEnd;
Ben Wagner8d45a382017-11-16 10:08:28 -0500409 int32_t fUTF16LogicalPosition;
410 UBiDiLevel fLevel;
411};
412
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400413class HbScriptRunIterator final : public SkShaper::ScriptRunIterator {
Ben Wagner8d45a382017-11-16 10:08:28 -0500414public:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400415 static SkTLazy<HbScriptRunIterator> Make(const char* utf8, size_t utf8Bytes,
416 hb_unicode_funcs_t* hbUnicode)
Ben Wagner8d45a382017-11-16 10:08:28 -0500417 {
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400418 SkTLazy<HbScriptRunIterator> ret;
Ben Wagner8d45a382017-11-16 10:08:28 -0500419 ret.init(utf8, utf8Bytes, hbUnicode);
420 return ret;
421 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400422 HbScriptRunIterator(const char* utf8, size_t utf8Bytes, hb_unicode_funcs_t* hbUnicode)
423 : fCurrent(utf8), fBegin(utf8), fEnd(fCurrent + utf8Bytes)
Ben Wagner8d45a382017-11-16 10:08:28 -0500424 , fHBUnicode(hbUnicode)
425 , fCurrentScript(HB_SCRIPT_UNKNOWN)
426 {}
427 void consume() override {
428 SkASSERT(fCurrent < fEnd);
Hal Canaryf107a2f2018-07-25 16:52:48 -0400429 SkUnichar u = utf8_next(&fCurrent, fEnd);
Ben Wagner8d45a382017-11-16 10:08:28 -0500430 fCurrentScript = hb_unicode_script(fHBUnicode, u);
431 while (fCurrent < fEnd) {
432 const char* prev = fCurrent;
Hal Canaryf107a2f2018-07-25 16:52:48 -0400433 u = utf8_next(&fCurrent, fEnd);
Ben Wagner8d45a382017-11-16 10:08:28 -0500434 const hb_script_t script = hb_unicode_script(fHBUnicode, u);
435 if (script != fCurrentScript) {
436 if (fCurrentScript == HB_SCRIPT_INHERITED || fCurrentScript == HB_SCRIPT_COMMON) {
437 fCurrentScript = script;
438 } else if (script == HB_SCRIPT_INHERITED || script == HB_SCRIPT_COMMON) {
439 continue;
440 } else {
441 fCurrent = prev;
442 break;
443 }
444 }
445 }
446 if (fCurrentScript == HB_SCRIPT_INHERITED) {
447 fCurrentScript = HB_SCRIPT_COMMON;
448 }
449 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400450 size_t endOfCurrentRun() const override {
451 return fCurrent - fBegin;
Ben Wagner8d45a382017-11-16 10:08:28 -0500452 }
453 bool atEnd() const override {
454 return fCurrent == fEnd;
455 }
456
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400457 SkFourByteTag currentScript() const override {
458 return SkSetFourByteTag(HB_UNTAG(fCurrentScript));
Ben Wagner8d45a382017-11-16 10:08:28 -0500459 }
460private:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400461 char const * fCurrent;
462 char const * const fBegin;
463 char const * const fEnd;
Ben Wagner8d45a382017-11-16 10:08:28 -0500464 hb_unicode_funcs_t* fHBUnicode;
465 hb_script_t fCurrentScript;
466};
467
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400468class FontMgrRunIterator final : public SkShaper::FontRunIterator {
Ben Wagner8d45a382017-11-16 10:08:28 -0500469public:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400470 static SkTLazy<FontMgrRunIterator> Make(const char* utf8, size_t utf8Bytes,
471 SkFont font,
472 sk_sp<SkFontMgr> fallbackMgr)
Ben Wagner8d45a382017-11-16 10:08:28 -0500473 {
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400474 SkTLazy<FontMgrRunIterator> ret;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400475 font.setTypeface(font.refTypefaceOrDefault());
Ben Wagnerf61c9362019-02-13 12:01:45 -0500476 HBFont hbFont = create_hb_font(font);
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400477 if (!hbFont) {
478 SkDebugf("create_hb_font failed!\n");
479 return ret;
480 }
481 ret.init(utf8, utf8Bytes, std::move(font), std::move(hbFont), std::move(fallbackMgr));
Ben Wagner8d45a382017-11-16 10:08:28 -0500482 return ret;
483 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400484 FontMgrRunIterator(const char* utf8, size_t utf8Bytes, SkFont font,
485 HBFont hbFont, sk_sp<SkFontMgr> fallbackMgr)
486 : fCurrent(utf8), fBegin(utf8), fEnd(fCurrent + utf8Bytes)
Ben Wagner8d45a382017-11-16 10:08:28 -0500487 , fFallbackMgr(std::move(fallbackMgr))
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400488 , fFont(std::move(font))
489 , fFallbackFont(fFont)
490 , fCurrentFont(&fFont)
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400491 {
492 fFallbackFont.setTypeface(nullptr);
493 }
Ben Wagner8d45a382017-11-16 10:08:28 -0500494 void consume() override {
495 SkASSERT(fCurrent < fEnd);
Hal Canaryf107a2f2018-07-25 16:52:48 -0400496 SkUnichar u = utf8_next(&fCurrent, fEnd);
Ben Wagner8d45a382017-11-16 10:08:28 -0500497 // If the starting typeface can handle this character, use it.
Ben Wagnera8d94c12019-02-12 14:11:49 -0500498 if (fFont.unicharToGlyph(u)) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400499 fCurrentFont = &fFont;
Ben Wagnera900ad52018-08-31 17:48:19 -0400500 // If the current fallback can handle this character, use it.
Ben Wagnera8d94c12019-02-12 14:11:49 -0500501 } else if (fFallbackFont.getTypeface() && fFallbackFont.unicharToGlyph(u)) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400502 fCurrentFont = &fFallbackFont;
Ben Wagner8d45a382017-11-16 10:08:28 -0500503 // If not, try to find a fallback typeface
504 } else {
Ben Wagnera8d94c12019-02-12 14:11:49 -0500505 sk_sp<SkTypeface> candidate(fFallbackMgr->matchFamilyStyleCharacter(
506 nullptr, fFont.getTypeface()->fontStyle(), nullptr, 0, u));
507 if (candidate) {
508 fFallbackFont.setTypeface(std::move(candidate));
Ben Wagnera8d94c12019-02-12 14:11:49 -0500509 fCurrentFont = &fFallbackFont;
Ben Wagnera8d94c12019-02-12 14:11:49 -0500510 } else {
511 fCurrentFont = &fFont;
Ben Wagnera8d94c12019-02-12 14:11:49 -0500512 }
Ben Wagner8d45a382017-11-16 10:08:28 -0500513 }
514
515 while (fCurrent < fEnd) {
516 const char* prev = fCurrent;
Hal Canaryf107a2f2018-07-25 16:52:48 -0400517 u = utf8_next(&fCurrent, fEnd);
Ben Wagner8d45a382017-11-16 10:08:28 -0500518
Ben Wagnera8d94c12019-02-12 14:11:49 -0500519 // End run if not using initial typeface and initial typeface has this character.
520 if (fCurrentFont->getTypeface() != fFont.getTypeface() && fFont.unicharToGlyph(u)) {
Ben Wagner8d45a382017-11-16 10:08:28 -0500521 fCurrent = prev;
522 return;
523 }
Ben Wagnera8d94c12019-02-12 14:11:49 -0500524
525 // End run if current typeface does not have this character and some other font does.
526 if (!fCurrentFont->unicharToGlyph(u)) {
527 sk_sp<SkTypeface> candidate(fFallbackMgr->matchFamilyStyleCharacter(
528 nullptr, fFont.getTypeface()->fontStyle(), nullptr, 0, u));
529 if (candidate) {
530 fCurrent = prev;
531 return;
532 }
Ben Wagner8d45a382017-11-16 10:08:28 -0500533 }
534 }
535 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400536 size_t endOfCurrentRun() const override {
537 return fCurrent - fBegin;
Ben Wagner8d45a382017-11-16 10:08:28 -0500538 }
539 bool atEnd() const override {
540 return fCurrent == fEnd;
541 }
542
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400543 const SkFont& currentFont() const override {
544 return *fCurrentFont;
Ben Wagner8d45a382017-11-16 10:08:28 -0500545 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400546
Ben Wagner8d45a382017-11-16 10:08:28 -0500547private:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400548 char const * fCurrent;
549 char const * const fBegin;
550 char const * const fEnd;
Ben Wagner8d45a382017-11-16 10:08:28 -0500551 sk_sp<SkFontMgr> fFallbackMgr;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400552 SkFont fFont;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400553 SkFont fFallbackFont;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400554 SkFont* fCurrentFont;
555};
556
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400557class StdLanguageRunIterator final : public SkShaper::LanguageRunIterator {
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400558public:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400559 static SkTLazy<StdLanguageRunIterator> Make(const char* utf8, size_t utf8Bytes) {
560 SkTLazy<StdLanguageRunIterator> ret;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400561 ret.init(utf8, utf8Bytes);
562 return ret;
563 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400564 StdLanguageRunIterator(const char* utf8, size_t utf8Bytes)
565 : fCurrent(utf8), fBegin(utf8), fEnd(fCurrent + utf8Bytes)
566 , fLanguage(std::locale().name().c_str())
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400567 { }
568 void consume() override {
569 // Ideally something like cld2/3 could be used, or user signals.
570 SkASSERT(fCurrent < fEnd);
571 fCurrent = fEnd;
572 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400573 size_t endOfCurrentRun() const override {
574 return fCurrent - fBegin;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400575 }
576 bool atEnd() const override {
577 return fCurrent == fEnd;
578 }
579
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400580 const char* currentLanguage() const override {
581 return fLanguage.c_str();
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400582 }
583private:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400584 char const * fCurrent;
585 char const * const fBegin;
586 char const * const fEnd;
587 const SkString fLanguage;
Ben Wagner8d45a382017-11-16 10:08:28 -0500588};
589
590class RunIteratorQueue {
591public:
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400592 void insert(SkShaper::RunIterator* runIterator) {
Ben Wagner8d45a382017-11-16 10:08:28 -0500593 fRunIterators.insert(runIterator);
594 }
595
596 bool advanceRuns() {
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400597 const SkShaper::RunIterator* leastRun = fRunIterators.peek();
Ben Wagner8d45a382017-11-16 10:08:28 -0500598 if (leastRun->atEnd()) {
599 SkASSERT(this->allRunsAreAtEnd());
600 return false;
601 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400602 const size_t leastEnd = leastRun->endOfCurrentRun();
603 SkShaper::RunIterator* currentRun = nullptr;
604 SkDEBUGCODE(size_t previousEndOfCurrentRun);
Ben Wagner8d45a382017-11-16 10:08:28 -0500605 while ((currentRun = fRunIterators.peek())->endOfCurrentRun() <= leastEnd) {
606 fRunIterators.pop();
607 SkDEBUGCODE(previousEndOfCurrentRun = currentRun->endOfCurrentRun());
608 currentRun->consume();
609 SkASSERT(previousEndOfCurrentRun < currentRun->endOfCurrentRun());
610 fRunIterators.insert(currentRun);
611 }
612 return true;
613 }
614
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400615 size_t endOfCurrentRun() const {
Ben Wagner8d45a382017-11-16 10:08:28 -0500616 return fRunIterators.peek()->endOfCurrentRun();
617 }
618
619private:
620 bool allRunsAreAtEnd() const {
621 for (int i = 0; i < fRunIterators.count(); ++i) {
622 if (!fRunIterators.at(i)->atEnd()) {
623 return false;
624 }
625 }
626 return true;
627 }
628
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400629 static bool CompareRunIterator(SkShaper::RunIterator* const& a, SkShaper::RunIterator* const& b) {
630 return a->endOfCurrentRun() < b->endOfCurrentRun();
Ben Wagner8d45a382017-11-16 10:08:28 -0500631 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400632 SkTDPQueue<SkShaper::RunIterator*, CompareRunIterator> fRunIterators;
Ben Wagner8d45a382017-11-16 10:08:28 -0500633};
634
635struct ShapedGlyph {
636 SkGlyphID fID;
637 uint32_t fCluster;
638 SkPoint fOffset;
639 SkVector fAdvance;
640 bool fMayLineBreakBefore;
641 bool fMustLineBreakBefore;
642 bool fHasVisual;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400643 bool fGraphemeBreakBefore;
644 bool fUnsafeToBreak;
Ben Wagner8d45a382017-11-16 10:08:28 -0500645};
646struct ShapedRun {
Ben Wagner7415a422019-03-25 15:38:22 -0400647 ShapedRun(SkShaper::RunHandler::Range utf8Range, const SkFont& font, UBiDiLevel level,
648 std::unique_ptr<ShapedGlyph[]> glyphs, size_t numGlyphs, SkVector advance = {0, 0})
649 : fUtf8Range(utf8Range), fFont(font), fLevel(level)
650 , fGlyphs(std::move(glyphs)), fNumGlyphs(numGlyphs), fAdvance(advance)
Ben Wagner8d45a382017-11-16 10:08:28 -0500651 {}
652
Ben Wagner7415a422019-03-25 15:38:22 -0400653 SkShaper::RunHandler::Range fUtf8Range;
Mike Reed6d595682018-12-05 17:28:14 -0500654 SkFont fFont;
Ben Wagner8d45a382017-11-16 10:08:28 -0500655 UBiDiLevel fLevel;
656 std::unique_ptr<ShapedGlyph[]> fGlyphs;
Ben Wagner7415a422019-03-25 15:38:22 -0400657 size_t fNumGlyphs;
658 SkVector fAdvance;
Ben Wagner8d45a382017-11-16 10:08:28 -0500659};
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400660struct ShapedLine {
661 SkTArray<ShapedRun> runs;
662 SkVector fAdvance = { 0, 0 };
663};
Ben Wagner8d45a382017-11-16 10:08:28 -0500664
665static constexpr bool is_LTR(UBiDiLevel level) {
666 return (level & 1) == 0;
667}
668
Florin Malita950243d2019-01-11 11:08:35 -0500669static void append(SkShaper::RunHandler* handler, const SkShaper::RunHandler::RunInfo& runInfo,
Ben Wagner7415a422019-03-25 15:38:22 -0400670 const ShapedRun& run, size_t startGlyphIndex, size_t endGlyphIndex,
Florin Malita9867f612018-12-12 10:54:49 -0500671 SkPoint* p) {
Ben Wagner7415a422019-03-25 15:38:22 -0400672 SkASSERT(startGlyphIndex <= endGlyphIndex);
673 const size_t glyphLen = endGlyphIndex - startGlyphIndex;
Florin Malita9867f612018-12-12 10:54:49 -0500674
Ben Wagner7415a422019-03-25 15:38:22 -0400675 const auto buffer = handler->newRunBuffer(runInfo, run.fFont, glyphLen, run.fUtf8Range);
Florin Malita9867f612018-12-12 10:54:49 -0500676 SkASSERT(buffer.glyphs);
677 SkASSERT(buffer.positions);
678
Ben Wagner7415a422019-03-25 15:38:22 -0400679 for (size_t i = 0; i < glyphLen; i++) {
Ben Wagner8d45a382017-11-16 10:08:28 -0500680 // Glyphs are in logical order, but output ltr since PDF readers seem to expect that.
Ben Wagner7415a422019-03-25 15:38:22 -0400681 const ShapedGlyph& glyph = run.fGlyphs[is_LTR(run.fLevel) ? startGlyphIndex + i
682 : endGlyphIndex - 1 - i];
Florin Malita9867f612018-12-12 10:54:49 -0500683 buffer.glyphs[i] = glyph.fID;
684 buffer.positions[i] = SkPoint::Make(p->fX + glyph.fOffset.fX, p->fY - glyph.fOffset.fY);
685 if (buffer.clusters) {
686 buffer.clusters[i] = glyph.fCluster;
687 }
Ben Wagner8d45a382017-11-16 10:08:28 -0500688 p->fX += glyph.fAdvance.fX;
689 p->fY += glyph.fAdvance.fY;
690 }
Ben Wagner454e5fb2019-02-08 17:46:38 -0500691 handler->commitRun();
Ben Wagner8d45a382017-11-16 10:08:28 -0500692}
693
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400694static void emit(const ShapedLine& line, SkShaper::RunHandler* handler,
Florin Malita500133b2019-02-07 10:56:55 -0500695 SkPoint point, SkPoint& currentPoint)
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400696{
697 // Reorder the runs and glyphs per line and write them out.
698 SkScalar maxAscent = 0;
699 SkScalar maxDescent = 0;
700 SkScalar maxLeading = 0;
701 for (const ShapedRun& run : line.runs) {
702 SkFontMetrics metrics;
703 run.fFont.getMetrics(&metrics);
704 maxAscent = SkTMin(maxAscent, metrics.fAscent);
705 maxDescent = SkTMax(maxDescent, metrics.fDescent);
706 maxLeading = SkTMax(maxLeading, metrics.fLeading);
707 }
708
709 int numRuns = line.runs.size();
710 SkAutoSTMalloc<4, UBiDiLevel> runLevels(numRuns);
711 for (int i = 0; i < numRuns; ++i) {
712 runLevels[i] = line.runs[i].fLevel;
713 }
714 SkAutoSTMalloc<4, int32_t> logicalFromVisual(numRuns);
715 ubidi_reorderVisual(runLevels, numRuns, logicalFromVisual);
716
717 currentPoint.fY -= maxAscent;
718
719 for (int i = 0; i < numRuns; ++i) {
720 int logicalIndex = logicalFromVisual[i];
721
722 const auto& run = line.runs[logicalIndex];
723 const SkShaper::RunHandler::RunInfo info = {
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400724 run.fAdvance,
725 maxAscent,
726 maxDescent,
727 maxLeading,
728 };
729 append(handler, info, run, 0, run.fNumGlyphs, &currentPoint);
730 }
731
732 currentPoint.fY += maxDescent + maxLeading;
733 currentPoint.fX = point.fX;
734
Florin Malita500133b2019-02-07 10:56:55 -0500735 handler->commitLine();
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400736}
737
Ben Wagner8d45a382017-11-16 10:08:28 -0500738struct ShapedRunGlyphIterator {
739 ShapedRunGlyphIterator(const SkTArray<ShapedRun>& origRuns)
740 : fRuns(&origRuns), fRunIndex(0), fGlyphIndex(0)
741 { }
742
743 ShapedRunGlyphIterator(const ShapedRunGlyphIterator& that) = default;
744 ShapedRunGlyphIterator& operator=(const ShapedRunGlyphIterator& that) = default;
745 bool operator==(const ShapedRunGlyphIterator& that) const {
746 return fRuns == that.fRuns &&
747 fRunIndex == that.fRunIndex &&
748 fGlyphIndex == that.fGlyphIndex;
749 }
750 bool operator!=(const ShapedRunGlyphIterator& that) const {
751 return fRuns != that.fRuns ||
752 fRunIndex != that.fRunIndex ||
753 fGlyphIndex != that.fGlyphIndex;
754 }
755
756 ShapedGlyph* next() {
757 const SkTArray<ShapedRun>& runs = *fRuns;
758 SkASSERT(fRunIndex < runs.count());
759 SkASSERT(fGlyphIndex < runs[fRunIndex].fNumGlyphs);
760
761 ++fGlyphIndex;
762 if (fGlyphIndex == runs[fRunIndex].fNumGlyphs) {
763 fGlyphIndex = 0;
764 ++fRunIndex;
765 if (fRunIndex >= runs.count()) {
766 return nullptr;
767 }
768 }
769 return &runs[fRunIndex].fGlyphs[fGlyphIndex];
770 }
771
772 ShapedGlyph* current() {
773 const SkTArray<ShapedRun>& runs = *fRuns;
774 if (fRunIndex >= runs.count()) {
775 return nullptr;
776 }
777 return &runs[fRunIndex].fGlyphs[fGlyphIndex];
778 }
779
780 const SkTArray<ShapedRun>* fRuns;
781 int fRunIndex;
Ben Wagner7415a422019-03-25 15:38:22 -0400782 size_t fGlyphIndex;
Ben Wagner8d45a382017-11-16 10:08:28 -0500783};
784
785} // namespace
786
Ben Wagnerb0591942019-02-15 14:46:18 -0500787class SkShaperHarfBuzz : public SkShaper {
788public:
789 SkShaperHarfBuzz();
790 bool good() const;
791private:
Ben Wagner8d45a382017-11-16 10:08:28 -0500792 HBBuffer fBuffer;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400793 ICUBrk fLineBreakIterator;
794 ICUBrk fGraphemeBreakIterator;
795
Ben Wagnerb0591942019-02-15 14:46:18 -0500796 SkPoint shape(SkShaper::RunHandler* handler,
797 const SkFont& srcFont,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400798 const char* utf8, size_t utf8Bytes,
Ben Wagnerb0591942019-02-15 14:46:18 -0500799 bool leftToRight,
800 SkPoint point,
801 SkScalar width) const override;
802
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400803 SkPoint shape(const char* utf8Text, size_t textBytes,
804 FontRunIterator&,
805 BiDiRunIterator&,
806 ScriptRunIterator&,
807 LanguageRunIterator&,
808 SkPoint point,
809 SkScalar width,
810 RunHandler*) const override;
811
Ben Wagner7415a422019-03-25 15:38:22 -0400812 SkPoint shapeCorrect(RunHandler* handler,
813 char const * const utf8,
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400814 size_t utf8Bytes,
815 SkPoint point,
816 SkScalar width,
817 RunIteratorQueue& runSegmenter,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400818 const BiDiRunIterator& bidi,
819 const LanguageRunIterator& language,
820 const ScriptRunIterator& script,
821 const FontRunIterator& font) const;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400822
Ben Wagnerb0591942019-02-15 14:46:18 -0500823 SkPoint shapeOk(SkShaper::RunHandler* handler,
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400824 const char* utf8,
825 size_t utf8Bytes,
826 SkPoint point,
827 SkScalar width,
828 RunIteratorQueue& runSegmenter,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400829 const BiDiRunIterator& bidi,
830 const LanguageRunIterator& language,
831 const ScriptRunIterator& script,
832 const FontRunIterator& font) const;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400833
834 ShapedRun shape(const char* utf8,
835 size_t utf8Bytes,
836 const char* utf8Start,
837 const char* utf8End,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400838 const BiDiRunIterator& bidi,
839 const LanguageRunIterator& language,
840 const ScriptRunIterator& script,
841 const FontRunIterator& font) const;
Ben Wagner8d45a382017-11-16 10:08:28 -0500842};
843
Ben Wagnerb0591942019-02-15 14:46:18 -0500844std::unique_ptr<SkShaper> SkShaper::MakeHarfBuzz() {
845 auto hb = skstd::make_unique<SkShaperHarfBuzz>();
846 return hb->good() ? std::move(hb) : nullptr;
847}
848
849SkShaperHarfBuzz::SkShaperHarfBuzz() {
Hal Canary61021922019-02-06 12:29:11 -0500850#if defined(SK_USING_THIRD_PARTY_ICU)
851 if (!SkLoadICU()) {
852 SkDebugf("SkLoadICU() failed!\n");
853 return;
854 }
855#endif
Ben Wagnerb0591942019-02-15 14:46:18 -0500856 fBuffer.reset(hb_buffer_create());
857 SkASSERT(fBuffer);
Ben Wagner8d45a382017-11-16 10:08:28 -0500858
Ben Wagner8d45a382017-11-16 10:08:28 -0500859 UErrorCode status = U_ZERO_ERROR;
Ben Wagnerb0591942019-02-15 14:46:18 -0500860 fLineBreakIterator.reset(ubrk_open(UBRK_LINE, "th", nullptr, 0, &status));
Ben Wagner8d45a382017-11-16 10:08:28 -0500861 if (U_FAILURE(status)) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400862 SkDebugf("Could not create line break iterator: %s", u_errorName(status));
Ben Wagner8d45a382017-11-16 10:08:28 -0500863 SK_ABORT("");
864 }
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400865
Ben Wagnerb0591942019-02-15 14:46:18 -0500866 fGraphemeBreakIterator.reset(ubrk_open(UBRK_CHARACTER, "th", nullptr, 0, &status));
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400867 if (U_FAILURE(status)) {
868 SkDebugf("Could not create grapheme break iterator: %s", u_errorName(status));
869 SK_ABORT("");
870 }
871
Ben Wagnera25fbef2017-08-30 13:56:19 -0400872}
873
Ben Wagnerb0591942019-02-15 14:46:18 -0500874bool SkShaperHarfBuzz::good() const {
875 return fBuffer &&
876 fLineBreakIterator &&
877 fGraphemeBreakIterator;
Ben Wagner8d45a382017-11-16 10:08:28 -0500878}
Ben Wagnera25fbef2017-08-30 13:56:19 -0400879
Ben Wagnerb0591942019-02-15 14:46:18 -0500880SkPoint SkShaperHarfBuzz::shape(SkShaper::RunHandler* handler,
881 const SkFont& srcFont,
882 const char* utf8,
883 size_t utf8Bytes,
884 bool leftToRight,
885 SkPoint point,
886 SkScalar width) const
Ben Wagner8d45a382017-11-16 10:08:28 -0500887{
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400888 SkASSERT(handler);
889 sk_sp<SkFontMgr> fontMgr = SkFontMgr::RefDefault();
890 UBiDiLevel defaultLevel = leftToRight ? UBIDI_DEFAULT_LTR : UBIDI_DEFAULT_RTL;
891
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400892 SkTLazy<IcuBiDiRunIterator> maybeBidi(IcuBiDiRunIterator::Make(utf8, utf8Bytes, defaultLevel));
Ben Wagner8d45a382017-11-16 10:08:28 -0500893 BiDiRunIterator* bidi = maybeBidi.getMaybeNull();
894 if (!bidi) {
Ben Wagner5d4dd8b2018-01-25 14:37:17 -0500895 return point;
Ben Wagnera25fbef2017-08-30 13:56:19 -0400896 }
Ben Wagnera25fbef2017-08-30 13:56:19 -0400897
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400898 SkTLazy<StdLanguageRunIterator> maybeLanguage(StdLanguageRunIterator::Make(utf8, utf8Bytes));
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400899 LanguageRunIterator* language = maybeLanguage.getMaybeNull();
900 if (!language) {
901 return point;
902 }
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400903
Ben Wagnerb0591942019-02-15 14:46:18 -0500904 hb_unicode_funcs_t* hbUnicode = hb_buffer_get_unicode_funcs(fBuffer.get());
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400905 SkTLazy<HbScriptRunIterator> maybeScript(HbScriptRunIterator::Make(utf8, utf8Bytes, hbUnicode));
Ben Wagner8d45a382017-11-16 10:08:28 -0500906 ScriptRunIterator* script = maybeScript.getMaybeNull();
907 if (!script) {
Ben Wagner5d4dd8b2018-01-25 14:37:17 -0500908 return point;
Ben Wagnera25fbef2017-08-30 13:56:19 -0400909 }
Ben Wagnera25fbef2017-08-30 13:56:19 -0400910
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400911 SkTLazy<FontMgrRunIterator> maybeFont(FontMgrRunIterator::Make(utf8, utf8Bytes,
912 srcFont, std::move(fontMgr)));
Ben Wagner8d45a382017-11-16 10:08:28 -0500913 FontRunIterator* font = maybeFont.getMaybeNull();
914 if (!font) {
Ben Wagner5d4dd8b2018-01-25 14:37:17 -0500915 return point;
Ben Wagnera25fbef2017-08-30 13:56:19 -0400916 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400917
918 return this->shape(utf8, utf8Bytes, *font, *bidi, *script, *language, point, width, handler);
919}
920
921SkPoint SkShaperHarfBuzz::shape(const char* utf8, size_t utf8Bytes,
922 FontRunIterator& font,
923 BiDiRunIterator& bidi,
924 ScriptRunIterator& script,
925 LanguageRunIterator& language,
926 SkPoint point,
927 SkScalar width,
928 RunHandler* handler) const
929{
930 RunIteratorQueue runSegmenter;
931 runSegmenter.insert(&font);
932 runSegmenter.insert(&bidi);
933 runSegmenter.insert(&script);
934 runSegmenter.insert(&language);
Ben Wagnera25fbef2017-08-30 13:56:19 -0400935
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400936 if (true) {
Ben Wagnerb0591942019-02-15 14:46:18 -0500937 return shapeCorrect(handler, utf8, utf8Bytes, point, width,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400938 runSegmenter, bidi, language, script, font);
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400939 } else {
Ben Wagnerb0591942019-02-15 14:46:18 -0500940 return shapeOk(handler, utf8, utf8Bytes, point, width,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400941 runSegmenter, bidi, language, script, font);
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400942 }
943}
944
Ben Wagnerb0591942019-02-15 14:46:18 -0500945SkPoint SkShaperHarfBuzz::shapeCorrect(RunHandler* handler,
Ben Wagner7415a422019-03-25 15:38:22 -0400946 char const * const utf8,
Ben Wagnerb0591942019-02-15 14:46:18 -0500947 size_t utf8Bytes,
948 SkPoint point,
949 SkScalar width,
950 RunIteratorQueue& runSegmenter,
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400951 const BiDiRunIterator& bidi,
952 const LanguageRunIterator& language,
953 const ScriptRunIterator& script,
954 const FontRunIterator& font) const
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400955{
956 ShapedLine line;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400957 SkPoint currentPoint = point;
958
959 const char* utf8Start = nullptr;
960 const char* utf8End = utf8;
961 while (runSegmenter.advanceRuns()) { // For each item
962 utf8Start = utf8End;
Ben Wagner1e08a7c2019-03-27 15:37:13 -0400963 utf8End = utf8 + runSegmenter.endOfCurrentRun();
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400964
Ben Wagner7415a422019-03-25 15:38:22 -0400965 ShapedRun model(RunHandler::Range(), SkFont(), 0, nullptr, 0);
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400966 bool modelNeedsRegenerated = true;
Ben Wagner7415a422019-03-25 15:38:22 -0400967 int modelGlyphOffset = 0;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400968
969 struct TextProps {
970 int glyphLen = 0;
971 SkVector advance = {0, 0};
972 };
973 // map from character position to [safe to break, glyph position, advance]
974 std::unique_ptr<TextProps[]> modelText;
975 int modelTextOffset = 0;
Ben Wagner7415a422019-03-25 15:38:22 -0400976 SkVector modelAdvanceOffset = {0, 0};
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400977
978 while (utf8Start < utf8End) { // While there are still code points left in this item
979 size_t utf8runLength = utf8End - utf8Start;
980 if (modelNeedsRegenerated) {
981 model = shape(utf8, utf8Bytes,
982 utf8Start, utf8End,
983 bidi, language, script, font);
Ben Wagner7415a422019-03-25 15:38:22 -0400984 modelGlyphOffset = 0;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400985
986 SkVector advance = {0, 0};
987 modelText.reset(new TextProps[utf8runLength + 1]());
Ben Wagnerb9cc1c62019-02-14 14:12:48 -0500988 size_t modelStartCluster = utf8Start - utf8;
Ben Wagner7415a422019-03-25 15:38:22 -0400989 for (size_t i = 0; i < model.fNumGlyphs; ++i) {
Ben Wagner84cc4612019-02-14 17:13:21 -0500990 SkASSERT(modelStartCluster <= model.fGlyphs[i].fCluster);
Ben Wagner2fe1e232019-02-14 17:37:02 -0500991 SkASSERT( model.fGlyphs[i].fCluster < (size_t)(utf8End - utf8));
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400992 if (!model.fGlyphs[i].fUnsafeToBreak) {
Ben Wagnerb9cc1c62019-02-14 14:12:48 -0500993 modelText[model.fGlyphs[i].fCluster - modelStartCluster].glyphLen = i;
994 modelText[model.fGlyphs[i].fCluster - modelStartCluster].advance = advance;
Ben Wagner0ec8ec22018-09-04 18:17:13 -0400995 }
996 advance += model.fGlyphs[i].fAdvance;
997 }
998 // Assume it is always safe to break after the end of an item
999 modelText[utf8runLength].glyphLen = model.fNumGlyphs;
1000 modelText[utf8runLength].advance = model.fAdvance;
1001 modelTextOffset = 0;
Ben Wagner7415a422019-03-25 15:38:22 -04001002 modelAdvanceOffset = {0, 0};
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001003 modelNeedsRegenerated = false;
1004 }
1005
1006 // TODO: break iterator per item, but just reset position if needed?
1007 // Maybe break iterator with model?
1008 UBreakIterator& breakIterator = *fLineBreakIterator;
1009 {
1010 UErrorCode status = U_ZERO_ERROR;
1011 UText utf8UText = UTEXT_INITIALIZER;
1012 utext_openUTF8(&utf8UText, utf8Start, utf8runLength, &status);
1013 std::unique_ptr<UText, SkFunctionWrapper<UText*, UText, utext_close>> autoClose(&utf8UText);
1014 if (U_FAILURE(status)) {
1015 SkDebugf("Could not create utf8UText: %s", u_errorName(status));
1016 return point;
1017 }
1018 ubrk_setUText(&breakIterator, &utf8UText, &status);
1019 if (U_FAILURE(status)) {
1020 SkDebugf("Could not setText on break iterator: %s", u_errorName(status));
1021 return point;
1022 }
1023 }
1024
Ben Wagner7415a422019-03-25 15:38:22 -04001025 ShapedRun best(RunHandler::Range(), SkFont(), 0, nullptr, 0,
1026 { SK_ScalarNegativeInfinity, SK_ScalarNegativeInfinity });
1027 bool bestIsInvalid = true;
1028 bool bestUsesModelForGlyphs = false;
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001029 SkScalar widthLeft = width - line.fAdvance.fX;
1030
1031 for (int32_t breakIteratorCurrent = ubrk_next(&breakIterator);
1032 breakIteratorCurrent != UBRK_DONE;
1033 breakIteratorCurrent = ubrk_next(&breakIterator))
1034 {
1035 // TODO: if past a safe to break, future safe to break will be at least as long
1036
1037 // TODO: adjust breakIteratorCurrent by ignorable whitespace
Ben Wagner7415a422019-03-25 15:38:22 -04001038 bool candidateUsesModelForGlyphs = false;
1039 ShapedRun candidate = [&](const TextProps& props){
1040 if (props.glyphLen) {
1041 candidateUsesModelForGlyphs = true;
1042 return ShapedRun(RunHandler::Range(utf8Start - utf8, breakIteratorCurrent),
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001043 font.currentFont(), bidi.currentLevel(),
Ben Wagner7415a422019-03-25 15:38:22 -04001044 std::unique_ptr<ShapedGlyph[]>(),
1045 props.glyphLen - modelGlyphOffset,
1046 props.advance - modelAdvanceOffset);
1047 } else {
1048 return shape(utf8, utf8Bytes,
1049 utf8Start, utf8Start + breakIteratorCurrent,
1050 bidi, language, script, font);
1051 }
1052 }(modelText[breakIteratorCurrent + modelTextOffset]);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001053 auto score = [widthLeft](const ShapedRun& run) -> SkScalar {
1054 if (run.fAdvance.fX < widthLeft) {
Ben Wagner7415a422019-03-25 15:38:22 -04001055 return run.fUtf8Range.size();
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001056 } else {
1057 return widthLeft - run.fAdvance.fX;
1058 }
1059 };
Ben Wagner7415a422019-03-25 15:38:22 -04001060 if (bestIsInvalid || score(best) < score(candidate)) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001061 best = std::move(candidate);
Ben Wagner7415a422019-03-25 15:38:22 -04001062 bestIsInvalid = false;
1063 bestUsesModelForGlyphs = candidateUsesModelForGlyphs;
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001064 }
1065 }
1066
1067 // If nothing fit (best score is negative) and the line is not empty
1068 if (width < line.fAdvance.fX + best.fAdvance.fX && !line.runs.empty()) {
Florin Malita500133b2019-02-07 10:56:55 -05001069 emit(line, handler, point, currentPoint);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001070 line.runs.reset();
1071 line.fAdvance = {0, 0};
1072 } else {
Ben Wagner7415a422019-03-25 15:38:22 -04001073 if (bestUsesModelForGlyphs) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001074 best.fGlyphs.reset(new ShapedGlyph[best.fNumGlyphs]);
Ben Wagner7415a422019-03-25 15:38:22 -04001075 memcpy(best.fGlyphs.get(), model.fGlyphs.get() + modelGlyphOffset,
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001076 best.fNumGlyphs * sizeof(ShapedGlyph));
Ben Wagner7415a422019-03-25 15:38:22 -04001077 modelGlyphOffset += best.fNumGlyphs;
1078 modelTextOffset += best.fUtf8Range.size();
1079 modelAdvanceOffset += best.fAdvance;
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001080 } else {
1081 modelNeedsRegenerated = true;
1082 }
Ben Wagner7415a422019-03-25 15:38:22 -04001083 utf8Start += best.fUtf8Range.size();
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001084 line.fAdvance += best.fAdvance;
1085 line.runs.emplace_back(std::move(best));
1086
1087 // If item broken, emit line (prevent remainder from accidentally fitting)
1088 if (utf8Start != utf8End) {
Florin Malita500133b2019-02-07 10:56:55 -05001089 emit(line, handler, point, currentPoint);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001090 line.runs.reset();
1091 line.fAdvance = {0, 0};
1092 }
1093 }
1094 }
1095 }
Florin Malita500133b2019-02-07 10:56:55 -05001096 emit(line, handler, point, currentPoint);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001097 return currentPoint;
1098}
1099
Ben Wagnerb0591942019-02-15 14:46:18 -05001100SkPoint SkShaperHarfBuzz::shapeOk(RunHandler* handler,
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001101 char const * const utf8,
Ben Wagnerb0591942019-02-15 14:46:18 -05001102 size_t utf8Bytes,
1103 SkPoint point,
1104 SkScalar width,
1105 RunIteratorQueue& runSegmenter,
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001106 const BiDiRunIterator& bidi,
1107 const LanguageRunIterator& language,
1108 const ScriptRunIterator& script,
1109 const FontRunIterator& font) const
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001110{
1111 SkTArray<ShapedRun> runs;
1112{
1113 UBreakIterator& lineBreakIterator = *fLineBreakIterator;
1114 UBreakIterator& graphemeBreakIterator = *fGraphemeBreakIterator;
Ben Wagner8d45a382017-11-16 10:08:28 -05001115 {
1116 UErrorCode status = U_ZERO_ERROR;
1117 UText utf8UText = UTEXT_INITIALIZER;
1118 utext_openUTF8(&utf8UText, utf8, utf8Bytes, &status);
1119 std::unique_ptr<UText, SkFunctionWrapper<UText*, UText, utext_close>> autoClose(&utf8UText);
1120 if (U_FAILURE(status)) {
1121 SkDebugf("Could not create utf8UText: %s", u_errorName(status));
Ben Wagner5d4dd8b2018-01-25 14:37:17 -05001122 return point;
Ben Wagner8d45a382017-11-16 10:08:28 -05001123 }
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001124
1125 ubrk_setUText(&lineBreakIterator, &utf8UText, &status);
Ben Wagner8d45a382017-11-16 10:08:28 -05001126 if (U_FAILURE(status)) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001127 SkDebugf("Could not setText on line break iterator: %s", u_errorName(status));
1128 return point;
1129 }
1130 ubrk_setUText(&graphemeBreakIterator, &utf8UText, &status);
1131 if (U_FAILURE(status)) {
1132 SkDebugf("Could not setText on grapheme break iterator: %s", u_errorName(status));
Ben Wagner5d4dd8b2018-01-25 14:37:17 -05001133 return point;
Ben Wagner8d45a382017-11-16 10:08:28 -05001134 }
Ben Wagnera25fbef2017-08-30 13:56:19 -04001135 }
1136
Ben Wagner8d45a382017-11-16 10:08:28 -05001137 const char* utf8Start = nullptr;
1138 const char* utf8End = utf8;
1139 while (runSegmenter.advanceRuns()) {
1140 utf8Start = utf8End;
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001141 utf8End = utf8 + runSegmenter.endOfCurrentRun();
Ben Wagner8d45a382017-11-16 10:08:28 -05001142
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001143 runs.emplace_back(shape(utf8, utf8Bytes,
1144 utf8Start, utf8End,
1145 bidi, language, script, font));
1146 ShapedRun& run = runs.back();
Ben Wagnera25fbef2017-08-30 13:56:19 -04001147
Ben Wagner8d45a382017-11-16 10:08:28 -05001148 uint32_t previousCluster = 0xFFFFFFFF;
Ben Wagner7415a422019-03-25 15:38:22 -04001149 for (size_t i = 0; i < run.fNumGlyphs; ++i) {
Ben Wagner8d45a382017-11-16 10:08:28 -05001150 ShapedGlyph& glyph = run.fGlyphs[i];
Ben Wagnerb9cc1c62019-02-14 14:12:48 -05001151 int32_t glyphCluster = glyph.fCluster;
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001152
1153 int32_t lineBreakIteratorCurrent = ubrk_current(&lineBreakIterator);
1154 while (lineBreakIteratorCurrent != UBRK_DONE &&
1155 lineBreakIteratorCurrent < glyphCluster)
Ben Wagner8d45a382017-11-16 10:08:28 -05001156 {
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001157 lineBreakIteratorCurrent = ubrk_next(&lineBreakIterator);
Ben Wagner2868b782017-08-31 14:12:27 -04001158 }
Ben Wagner8d45a382017-11-16 10:08:28 -05001159 glyph.fMayLineBreakBefore = glyph.fCluster != previousCluster &&
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001160 lineBreakIteratorCurrent == glyphCluster;
1161
1162 int32_t graphemeBreakIteratorCurrent = ubrk_current(&graphemeBreakIterator);
1163 while (graphemeBreakIteratorCurrent != UBRK_DONE &&
1164 graphemeBreakIteratorCurrent < glyphCluster)
1165 {
1166 graphemeBreakIteratorCurrent = ubrk_next(&graphemeBreakIterator);
1167 }
1168 glyph.fGraphemeBreakBefore = glyph.fCluster != previousCluster &&
1169 graphemeBreakIteratorCurrent == glyphCluster;
1170
Ben Wagner8d45a382017-11-16 10:08:28 -05001171 previousCluster = glyph.fCluster;
Ben Wagnera25fbef2017-08-30 13:56:19 -04001172 }
1173 }
Ben Wagner8d45a382017-11-16 10:08:28 -05001174}
1175
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001176// Iterate over the glyphs in logical order to find potential line lengths.
Ben Wagner8d45a382017-11-16 10:08:28 -05001177{
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001178 /** The position of the beginning of the line. */
1179 ShapedRunGlyphIterator beginning(runs);
1180
1181 /** The position of the candidate line break. */
1182 ShapedRunGlyphIterator candidateLineBreak(runs);
1183 SkScalar candidateLineBreakWidth = 0;
1184
1185 /** The position of the candidate grapheme break. */
1186 ShapedRunGlyphIterator candidateGraphemeBreak(runs);
1187 SkScalar candidateGraphemeBreakWidth = 0;
1188
1189 /** The position of the current location. */
1190 ShapedRunGlyphIterator current(runs);
1191 SkScalar currentWidth = 0;
1192 while (ShapedGlyph* glyph = current.current()) {
1193 // 'Break' at graphemes until a line boundary, then only at line boundaries.
1194 // Only break at graphemes if no line boundary is valid.
1195 if (current != beginning) {
1196 if (glyph->fGraphemeBreakBefore || glyph->fMayLineBreakBefore) {
1197 // TODO: preserve line breaks <= grapheme breaks
1198 // and prevent line breaks inside graphemes
1199 candidateGraphemeBreak = current;
1200 candidateGraphemeBreakWidth = currentWidth;
1201 if (glyph->fMayLineBreakBefore) {
1202 candidateLineBreak = current;
1203 candidateLineBreakWidth = currentWidth;
1204 }
1205 }
Ben Wagner8d45a382017-11-16 10:08:28 -05001206 }
1207
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001208 SkScalar glyphWidth = glyph->fAdvance.fX;
1209 // Break when overwidth, the glyph has a visual representation, and some space is used.
1210 if (width < currentWidth + glyphWidth && glyph->fHasVisual && candidateGraphemeBreakWidth > 0){
1211 if (candidateLineBreak != beginning) {
1212 beginning = candidateLineBreak;
1213 currentWidth -= candidateLineBreakWidth;
1214 candidateGraphemeBreakWidth -= candidateLineBreakWidth;
1215 candidateLineBreakWidth = 0;
1216 } else if (candidateGraphemeBreak != beginning) {
1217 beginning = candidateGraphemeBreak;
1218 candidateLineBreak = beginning;
1219 currentWidth -= candidateGraphemeBreakWidth;
1220 candidateGraphemeBreakWidth = 0;
1221 candidateLineBreakWidth = 0;
1222 } else {
1223 SK_ABORT("");
1224 }
1225
1226 if (width < currentWidth) {
1227 if (width < candidateGraphemeBreakWidth) {
1228 candidateGraphemeBreak = candidateLineBreak;
1229 candidateGraphemeBreakWidth = candidateLineBreakWidth;
1230 }
1231 current = candidateGraphemeBreak;
1232 currentWidth = candidateGraphemeBreakWidth;
1233 }
1234
1235 glyph = beginning.current();
1236 if (glyph) {
1237 glyph->fMustLineBreakBefore = true;
1238 }
1239
1240 } else {
1241 current.next();
1242 currentWidth += glyphWidth;
Ben Wagner8d45a382017-11-16 10:08:28 -05001243 }
Ben Wagner8d45a382017-11-16 10:08:28 -05001244 }
1245}
1246
1247// Reorder the runs and glyphs per line and write them out.
Ben Wagner5d4dd8b2018-01-25 14:37:17 -05001248 SkPoint currentPoint = point;
Ben Wagner8d45a382017-11-16 10:08:28 -05001249{
1250 ShapedRunGlyphIterator previousBreak(runs);
1251 ShapedRunGlyphIterator glyphIterator(runs);
1252 SkScalar maxAscent = 0;
1253 SkScalar maxDescent = 0;
1254 SkScalar maxLeading = 0;
1255 int previousRunIndex = -1;
1256 while (glyphIterator.current()) {
1257 int runIndex = glyphIterator.fRunIndex;
Ben Wagner7415a422019-03-25 15:38:22 -04001258 size_t glyphIndex = glyphIterator.fGlyphIndex;
Ben Wagner8d45a382017-11-16 10:08:28 -05001259 ShapedGlyph* nextGlyph = glyphIterator.next();
1260
1261 if (previousRunIndex != runIndex) {
Mike Reedb5784ac2018-11-12 09:35:15 -05001262 SkFontMetrics metrics;
Mike Reed6d595682018-12-05 17:28:14 -05001263 runs[runIndex].fFont.getMetrics(&metrics);
Ben Wagner8d45a382017-11-16 10:08:28 -05001264 maxAscent = SkTMin(maxAscent, metrics.fAscent);
1265 maxDescent = SkTMax(maxDescent, metrics.fDescent);
1266 maxLeading = SkTMax(maxLeading, metrics.fLeading);
1267 previousRunIndex = runIndex;
1268 }
1269
1270 // Nothing can be written until the baseline is known.
1271 if (!(nextGlyph == nullptr || nextGlyph->fMustLineBreakBefore)) {
1272 continue;
1273 }
1274
1275 currentPoint.fY -= maxAscent;
1276
1277 int numRuns = runIndex - previousBreak.fRunIndex + 1;
1278 SkAutoSTMalloc<4, UBiDiLevel> runLevels(numRuns);
1279 for (int i = 0; i < numRuns; ++i) {
1280 runLevels[i] = runs[previousBreak.fRunIndex + i].fLevel;
1281 }
1282 SkAutoSTMalloc<4, int32_t> logicalFromVisual(numRuns);
1283 ubidi_reorderVisual(runLevels, numRuns, logicalFromVisual);
1284
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001285 // step through the runs in reverse visual order and the glyphs in reverse logical order
1286 // until a visible glyph is found and force them to the end of the visual line.
1287
Ben Wagner8d45a382017-11-16 10:08:28 -05001288 for (int i = 0; i < numRuns; ++i) {
1289 int logicalIndex = previousBreak.fRunIndex + logicalFromVisual[i];
1290
Ben Wagner7415a422019-03-25 15:38:22 -04001291 size_t startGlyphIndex = (logicalIndex == previousBreak.fRunIndex)
1292 ? previousBreak.fGlyphIndex
1293 : 0;
1294 size_t endGlyphIndex = (logicalIndex == runIndex)
1295 ? glyphIndex + 1
1296 : runs[logicalIndex].fNumGlyphs;
Florin Malita950243d2019-01-11 11:08:35 -05001297
1298 const auto& run = runs[logicalIndex];
1299 const RunHandler::RunInfo info = {
Florin Malita950243d2019-01-11 11:08:35 -05001300 run.fAdvance,
1301 maxAscent,
1302 maxDescent,
1303 maxLeading,
1304 };
1305 append(handler, info, run, startGlyphIndex, endGlyphIndex, &currentPoint);
Ben Wagner8d45a382017-11-16 10:08:28 -05001306 }
1307
Florin Malita500133b2019-02-07 10:56:55 -05001308 handler->commitLine();
1309
Ben Wagner8d45a382017-11-16 10:08:28 -05001310 currentPoint.fY += maxDescent + maxLeading;
1311 currentPoint.fX = point.fX;
1312 maxAscent = 0;
1313 maxDescent = 0;
1314 maxLeading = 0;
1315 previousRunIndex = -1;
1316 previousBreak = glyphIterator;
1317 }
1318}
1319
Ben Wagner5d4dd8b2018-01-25 14:37:17 -05001320 return currentPoint;
Ben Wagnera25fbef2017-08-30 13:56:19 -04001321}
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001322
1323
Ben Wagner7415a422019-03-25 15:38:22 -04001324ShapedRun SkShaperHarfBuzz::shape(char const * const utf8,
1325 size_t const utf8Bytes,
1326 char const * const utf8Start,
1327 char const * const utf8End,
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001328 const BiDiRunIterator& bidi,
1329 const LanguageRunIterator& language,
1330 const ScriptRunIterator& script,
1331 const FontRunIterator& font) const
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001332{
Ben Wagner7415a422019-03-25 15:38:22 -04001333 size_t utf8runLength = utf8End - utf8Start;
1334 ShapedRun run(RunHandler::Range(utf8Start - utf8, utf8runLength),
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001335 font.currentFont(), bidi.currentLevel(), nullptr, 0);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001336
1337 hb_buffer_t* buffer = fBuffer.get();
1338 SkAutoTCallVProc<hb_buffer_t, hb_buffer_clear_contents> autoClearBuffer(buffer);
1339 hb_buffer_set_content_type(buffer, HB_BUFFER_CONTENT_TYPE_UNICODE);
1340 hb_buffer_set_cluster_level(buffer, HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS);
1341
Ben Wagner2fc14742019-02-06 16:37:44 -05001342 // See 763e5466c0a03a7c27020e1e2598e488612529a7 for documentation.
1343 hb_buffer_set_flags(buffer, HB_BUFFER_FLAG_BOT | HB_BUFFER_FLAG_EOT);
1344
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001345 // Add precontext.
1346 hb_buffer_add_utf8(buffer, utf8, utf8Start - utf8, utf8Start - utf8, 0);
1347
1348 // Populate the hb_buffer directly with utf8 cluster indexes.
1349 const char* utf8Current = utf8Start;
1350 while (utf8Current < utf8End) {
Ben Wagnerb9cc1c62019-02-14 14:12:48 -05001351 unsigned int cluster = utf8Current - utf8;
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001352 hb_codepoint_t u = utf8_next(&utf8Current, utf8End);
1353 hb_buffer_add(buffer, u, cluster);
1354 }
1355
1356 // Add postcontext.
1357 hb_buffer_add_utf8(buffer, utf8Current, utf8 + utf8Bytes - utf8Current, 0, 0);
1358
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001359 hb_direction_t direction = is_LTR(bidi.currentLevel()) ? HB_DIRECTION_LTR:HB_DIRECTION_RTL;
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001360 hb_buffer_set_direction(buffer, direction);
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001361 hb_buffer_set_script(buffer, hb_script_from_iso15924_tag((hb_tag_t)script.currentScript()));
1362 hb_buffer_set_language(buffer, hb_language_from_string(language.currentLanguage(), -1));
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001363 hb_buffer_guess_segment_properties(buffer);
1364 // TODO: features
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001365
1366 // TODO: how to cache hbface (typeface) / hbfont (font)
1367 HBFont hbFont(create_hb_font(font.currentFont()));
1368 if (!hbFont) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001369 return run;
1370 }
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001371 hb_shape(hbFont.get(), buffer, nullptr, 0);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001372 unsigned len = hb_buffer_get_length(buffer);
1373 if (len == 0) {
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001374 return run;
1375 }
1376
1377 if (direction == HB_DIRECTION_RTL) {
1378 // Put the clusters back in logical order.
1379 // Note that the advances remain ltr.
1380 hb_buffer_reverse(buffer);
1381 }
1382 hb_glyph_info_t* info = hb_buffer_get_glyph_infos(buffer, nullptr);
1383 hb_glyph_position_t* pos = hb_buffer_get_glyph_positions(buffer, nullptr);
1384
Ben Wagner7415a422019-03-25 15:38:22 -04001385 run = ShapedRun(RunHandler::Range(utf8Start - utf8, utf8runLength),
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001386 font.currentFont(), bidi.currentLevel(),
Ben Wagner454e5fb2019-02-08 17:46:38 -05001387 std::unique_ptr<ShapedGlyph[]>(new ShapedGlyph[len]), len);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001388 int scaleX, scaleY;
Ben Wagner1e08a7c2019-03-27 15:37:13 -04001389 hb_font_get_scale(hbFont.get(), &scaleX, &scaleY);
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001390 double textSizeY = run.fFont.getSize() / scaleY;
1391 double textSizeX = run.fFont.getSize() / scaleX * run.fFont.getScaleX();
1392 SkVector runAdvance = { 0, 0 };
1393 for (unsigned i = 0; i < len; i++) {
1394 ShapedGlyph& glyph = run.fGlyphs[i];
1395 glyph.fID = info[i].codepoint;
1396 glyph.fCluster = info[i].cluster;
1397 glyph.fOffset.fX = pos[i].x_offset * textSizeX;
1398 glyph.fOffset.fY = pos[i].y_offset * textSizeY;
1399 glyph.fAdvance.fX = pos[i].x_advance * textSizeX;
1400 glyph.fAdvance.fY = pos[i].y_advance * textSizeY;
1401
1402 SkRect bounds;
1403 SkScalar advance;
1404 SkPaint p;
1405 run.fFont.getWidthsBounds(&glyph.fID, 1, &advance, &bounds, &p);
1406 glyph.fHasVisual = !bounds.isEmpty(); //!font->currentTypeface()->glyphBoundsAreZero(glyph.fID);
Kevin Lubick867da4b2019-02-22 15:55:39 -05001407#if SK_HB_VERSION_CHECK(1, 5, 0)
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001408 glyph.fUnsafeToBreak = info[i].mask & HB_GLYPH_FLAG_UNSAFE_TO_BREAK;
Kevin Lubick867da4b2019-02-22 15:55:39 -05001409#else
1410 glyph.fUnsafeToBreak = false;
1411#endif
Ben Wagner0ec8ec22018-09-04 18:17:13 -04001412 glyph.fMustLineBreakBefore = false;
1413
1414 runAdvance += glyph.fAdvance;
1415 }
1416 run.fAdvance = runAdvance;
1417
1418 return run;
1419}