mirror of
https://github.com/storytold/harfbuzz.git
synced 2026-11-20 14:31:10 +01:00
HarfRust signals a shaping failure -- a max_ops / preprocessing-budget trip, an allocation failure, or an internal error -- by returning false from its shape function, whereas the ot shaper always returns true and reports such failures through the buffer's success flag. Because hb_shape() returns void, hb_buffer_allocation_successful() is the only failure signal its callers have. The HarfRust shim returned false without touching the C hb_buffer_t, so after a HarfRust budget trip hb_buffer_allocation_successful() still reported success while the buffer was left unshaped. Mirror the ot shaper in hb-harfrust.cc: always return true and, on failure, mark the buffer unsuccessful. As with the ot shaper after a budget trip, the buffer is then labelled GLYPHS but its contents must not be trusted; the caller must check hb_buffer_allocation_successful(). Add a test-shape regression test that drives the HarfRust shaper with many ranged features (overrunning setup_masks()'s op budget) and asserts the failure now reaches hb_buffer_allocation_successful(). It runs in the test-shape-harfrust CI job and skips when HarfRust is not built. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
324 lines
9.7 KiB
C
324 lines
9.7 KiB
C
/*
|
|
* Copyright © 2011 Google, Inc.
|
|
*
|
|
* This is part of HarfBuzz, a text shaping library.
|
|
*
|
|
* Permission is hereby granted, without written agreement and without
|
|
* license or royalty fees, to use, copy, modify, and distribute this
|
|
* software and its documentation for any purpose, provided that the
|
|
* above copyright notice and the following two paragraphs appear in
|
|
* all copies of this software.
|
|
*
|
|
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
|
|
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
|
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
|
|
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
|
* DAMAGE.
|
|
*
|
|
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
|
|
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
|
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
|
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
|
|
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
|
*
|
|
* Google Author(s): Behdad Esfahbod
|
|
*/
|
|
|
|
#include "hb-test.h"
|
|
|
|
/* Unit tests for hb-shape.h */
|
|
|
|
/*
|
|
* This test provides a framework to test aspects of hb_shape() that are
|
|
* font-independent. Please add tests for any feature that fits that
|
|
* description.
|
|
*/
|
|
|
|
/* TODO Make this test data-driven and add some real test data */
|
|
/* TODO Test positions too. And test non-native direction. Test commit 2e18c6dbdfb */
|
|
|
|
|
|
static const char test_data[] = "test\0data";
|
|
|
|
static hb_position_t
|
|
glyph_h_advance_func (hb_font_t *font HB_UNUSED, void *font_data HB_UNUSED,
|
|
hb_codepoint_t glyph,
|
|
void *user_data HB_UNUSED)
|
|
{
|
|
switch (glyph) {
|
|
case 1: return 10;
|
|
case 2: return 6;
|
|
case 3: return 5;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static hb_bool_t
|
|
glyph_func (hb_font_t *font HB_UNUSED, void *font_data HB_UNUSED,
|
|
hb_codepoint_t unicode,
|
|
hb_codepoint_t *glyph,
|
|
void *user_data HB_UNUSED)
|
|
{
|
|
switch (unicode) {
|
|
case 'T': *glyph = 1; return TRUE;
|
|
case 'e': *glyph = 2; return TRUE;
|
|
case 's': *glyph = 3; return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
static const char TesT[] = "TesT";
|
|
|
|
static void
|
|
test_font (hb_font_t *font)
|
|
{
|
|
hb_buffer_t *buffer;
|
|
unsigned int len;
|
|
hb_glyph_info_t *glyphs;
|
|
hb_glyph_position_t *positions;
|
|
|
|
buffer = hb_buffer_create ();
|
|
hb_buffer_set_direction (buffer, HB_DIRECTION_LTR);
|
|
hb_buffer_add_utf8 (buffer, TesT, 4, 0, 4);
|
|
|
|
hb_shape (font, buffer, NULL, 0);
|
|
|
|
len = hb_buffer_get_length (buffer);
|
|
glyphs = hb_buffer_get_glyph_infos (buffer, NULL);
|
|
positions = hb_buffer_get_glyph_positions (buffer, NULL);
|
|
|
|
{
|
|
const hb_codepoint_t output_glyphs[] = {1, 2, 3, 1};
|
|
const hb_position_t output_x_advances[] = {10, 6, 5, 10};
|
|
const hb_position_t output_x_offsets[] = {0, 0, 0, 0};
|
|
unsigned int i;
|
|
g_assert_cmpint (len, ==, 4);
|
|
for (i = 0; i < len; i++) {
|
|
g_assert_cmphex (glyphs[i].codepoint, ==, output_glyphs[i]);
|
|
g_assert_cmphex (glyphs[i].cluster, ==, i);
|
|
}
|
|
for (i = 0; i < len; i++) {
|
|
g_assert_cmpint (output_x_advances[i], ==, positions[i].x_advance);
|
|
g_assert_cmpint (output_x_offsets [i], ==, positions[i].x_offset);
|
|
g_assert_cmpint (0, ==, positions[i].y_advance);
|
|
g_assert_cmpint (0, ==, positions[i].y_offset);
|
|
}
|
|
}
|
|
|
|
hb_buffer_destroy (buffer);
|
|
}
|
|
|
|
static void
|
|
test_shape (void)
|
|
{
|
|
hb_blob_t *blob;
|
|
hb_face_t *face;
|
|
hb_font_funcs_t *ffuncs;
|
|
hb_font_t *font, *sub_font;
|
|
|
|
blob = hb_blob_create (test_data, sizeof (test_data), HB_MEMORY_MODE_READONLY, NULL, NULL);
|
|
face = hb_face_create (blob, 0);
|
|
hb_blob_destroy (blob);
|
|
font = hb_font_create (face);
|
|
hb_face_destroy (face);
|
|
hb_font_set_scale (font, 10, 10);
|
|
|
|
ffuncs = hb_font_funcs_create ();
|
|
hb_font_funcs_set_glyph_h_advance_func (ffuncs, glyph_h_advance_func, NULL, NULL);
|
|
hb_font_funcs_set_nominal_glyph_func (ffuncs, glyph_func, malloc (10), free);
|
|
hb_font_set_funcs (font, ffuncs, NULL, NULL);
|
|
hb_font_funcs_destroy (ffuncs);
|
|
|
|
test_font (font);
|
|
|
|
sub_font = hb_font_create_sub_font (font);
|
|
test_font (sub_font);
|
|
|
|
hb_font_destroy (sub_font);
|
|
hb_font_destroy (font);
|
|
}
|
|
|
|
static void
|
|
test_shape_clusters (void)
|
|
{
|
|
hb_face_t *face;
|
|
hb_font_t *font;
|
|
hb_buffer_t *buffer;
|
|
unsigned int len;
|
|
hb_glyph_info_t *glyphs;
|
|
|
|
face = hb_face_create (NULL, 0);
|
|
font = hb_font_create (face);
|
|
hb_face_destroy (face);
|
|
|
|
buffer = hb_buffer_create ();
|
|
hb_buffer_set_direction (buffer, HB_DIRECTION_LTR);
|
|
{
|
|
/* https://crbug.com/497578 */
|
|
hb_codepoint_t test[] = {0xFFF1, 0xF0B6};
|
|
hb_buffer_add_utf32 (buffer, test, 2, 0, 2);
|
|
}
|
|
|
|
hb_shape (font, buffer, NULL, 0);
|
|
|
|
len = hb_buffer_get_length (buffer);
|
|
glyphs = hb_buffer_get_glyph_infos (buffer, NULL);
|
|
|
|
{
|
|
const hb_codepoint_t output_glyphs[] = {0};
|
|
const hb_position_t output_clusters[] = {0};
|
|
unsigned int i;
|
|
g_assert_cmpint (len, ==, 1);
|
|
for (i = 0; i < len; i++) {
|
|
g_assert_cmphex (glyphs[i].codepoint, ==, output_glyphs[i]);
|
|
g_assert_cmphex (glyphs[i].cluster, ==, output_clusters[i]);
|
|
}
|
|
}
|
|
|
|
hb_buffer_destroy (buffer);
|
|
hb_font_destroy (font);
|
|
}
|
|
|
|
static void
|
|
test_shape_overlong_mark_cluster (void)
|
|
{
|
|
hb_face_t *face = hb_test_open_font_file ("fonts/NotoSans-Bold.ttf");
|
|
hb_font_t *font = hb_font_create (face);
|
|
hb_buffer_t *buffer = hb_buffer_create ();
|
|
|
|
hb_font_set_scale (font, 12 * 65536, 12 * 65536);
|
|
hb_buffer_set_content_type (buffer, HB_BUFFER_CONTENT_TYPE_UNICODE);
|
|
hb_buffer_add (buffer, 'e', 0);
|
|
for (unsigned i = 0; i < 35000; i++)
|
|
hb_buffer_add (buffer, 0x0301, i + 1);
|
|
hb_buffer_add (buffer, 'X', 35001);
|
|
hb_buffer_guess_segment_properties (buffer);
|
|
|
|
hb_shape (font, buffer, NULL, 0);
|
|
|
|
unsigned len;
|
|
hb_glyph_position_t *positions = hb_buffer_get_glyph_positions (buffer, &len);
|
|
g_assert_cmpuint (len, ==, 35001);
|
|
g_assert_cmpint (positions[len - 2].y_offset, ==, INT32_MAX);
|
|
|
|
hb_buffer_destroy (buffer);
|
|
hb_font_destroy (font);
|
|
hb_face_destroy (face);
|
|
}
|
|
|
|
static void
|
|
test_shape_overlong_cluster_remerge (void)
|
|
{
|
|
/* The font has no space glyph, so default-ignorables are deleted in
|
|
* place. Shaped RTL, the deleted soft hyphens follow the big mark
|
|
* cluster with descending cluster values, so each deletion would rewrite
|
|
* the cluster of the whole preceding run. That re-merge walk must be
|
|
* charged to the buffer's op budget and fail the buffer, instead of
|
|
* taking O(N^2) time. */
|
|
hb_face_t *face = hb_test_open_font_file ("fonts/Roboto-Regular.abc.ttf");
|
|
hb_font_t *font = hb_font_create (face);
|
|
hb_buffer_t *buffer = hb_buffer_create ();
|
|
|
|
hb_buffer_set_content_type (buffer, HB_BUFFER_CONTENT_TYPE_UNICODE);
|
|
for (unsigned i = 0; i < 20000; i++)
|
|
hb_buffer_add (buffer, 0x00AD, i);
|
|
hb_buffer_add (buffer, 'a', 20000);
|
|
for (unsigned i = 0; i < 20000; i++)
|
|
hb_buffer_add (buffer, 0x0301, 20001 + i);
|
|
hb_buffer_guess_segment_properties (buffer);
|
|
hb_buffer_set_direction (buffer, HB_DIRECTION_RTL);
|
|
|
|
/* This exercises the native cluster re-merge op budget in hb-buffer.cc, so
|
|
* force the "ot" shaper: other shapers (e.g. harfrust) do their own cluster
|
|
* handling and never hit this path. */
|
|
const char *shaper_list[] = {"ot", NULL};
|
|
hb_shape_full (font, buffer, NULL, 0, shaper_list);
|
|
|
|
g_assert_true (!hb_buffer_allocation_successful (buffer));
|
|
|
|
hb_buffer_destroy (buffer);
|
|
hb_font_destroy (font);
|
|
hb_face_destroy (face);
|
|
}
|
|
|
|
|
|
static void
|
|
test_shape_harfrust_budget (void)
|
|
{
|
|
/* A HarfRust max_ops / preprocessing-budget trip must propagate to the C
|
|
* buffer's allocation_successful flag, the same way the ot shaper reports a
|
|
* budget failure. Many ranged (non-global) features make HarfRust's
|
|
* setup_masks() overrun the per-text op budget and mark its own buffer
|
|
* unsuccessful; hb-harfrust.cc must forward that to the hb_buffer_t so that a
|
|
* caller of the void-returning hb_shape() can see it. Only meaningful when
|
|
* HarfRust is built in, so skip otherwise. */
|
|
hb_bool_t have_harfrust = false;
|
|
for (const char * const *s = hb_shape_list_shapers (); *s; s++)
|
|
if (0 == strcmp (*s, "harfrust")) { have_harfrust = true; break; }
|
|
if (!have_harfrust)
|
|
{
|
|
g_test_skip ("HarfRust shaper not built");
|
|
return;
|
|
}
|
|
|
|
hb_face_t *face = hb_test_open_font_file ("fonts/Roboto-Regular.abc.ttf");
|
|
hb_font_t *font = hb_font_create (face);
|
|
hb_buffer_t *buffer = hb_buffer_create ();
|
|
|
|
hb_buffer_add_utf8 (buffer, "abcabcab", -1, 0, -1);
|
|
hb_buffer_guess_segment_properties (buffer);
|
|
|
|
/* One ranged feature per entry; count times the text length exceeds the
|
|
* per-text op budget, which HarfRust charges in setup_masks(). */
|
|
const unsigned num_features = 20000;
|
|
hb_feature_t *features = g_new0 (hb_feature_t, num_features);
|
|
for (unsigned i = 0; i < num_features; i++)
|
|
{
|
|
features[i].tag = HB_TAG ('k', 'e', 'r', 'n');
|
|
features[i].value = 0;
|
|
features[i].start = i;
|
|
features[i].end = i + 1;
|
|
}
|
|
|
|
const char *shaper_list[] = {"harfrust", NULL};
|
|
hb_shape_full (font, buffer, features, num_features, shaper_list);
|
|
|
|
g_assert_true (!hb_buffer_allocation_successful (buffer));
|
|
|
|
g_free (features);
|
|
hb_buffer_destroy (buffer);
|
|
hb_font_destroy (font);
|
|
hb_face_destroy (face);
|
|
}
|
|
|
|
|
|
static void
|
|
test_shape_list (void)
|
|
{
|
|
const char **shapers = hb_shape_list_shapers ();
|
|
|
|
unsigned int i;
|
|
for (i = 0; shapers[i]; i++)
|
|
;
|
|
|
|
g_assert_cmpint (i, >, 1);
|
|
g_assert_true (!strcmp (shapers[i - 1], "fallback"));
|
|
}
|
|
|
|
int
|
|
main (int argc, char **argv)
|
|
{
|
|
hb_test_init (&argc, &argv);
|
|
|
|
hb_test_add (test_shape);
|
|
hb_test_add (test_shape_clusters);
|
|
hb_test_add (test_shape_overlong_mark_cluster);
|
|
hb_test_add (test_shape_overlong_cluster_remerge);
|
|
hb_test_add (test_shape_harfrust_budget);
|
|
/* TODO test fallback shaper */
|
|
/* TODO test shaper_full */
|
|
hb_test_add (test_shape_list);
|
|
|
|
return hb_test_run();
|
|
}
|