Files
harfbuzz/test/api/test-ot-metrics.c
Behdad EsfahbodandClaude Opus 4.8 507575fd82 [metrics][layout] Accept NULL out-pointer where the docs allow it
hb_ot_metrics_get_position_with_fallback() and
hb_ot_layout_get_font_extents() / ...2() document their result pointer
as optional ((out) (optional) / (out) (nullable)), and one path in each
honours that, but the others dereference it: the metrics fallback reads
*position for the strikeout/underline zero check and writes it in every
synthesized arm, and the layout miss path hands the pointer unchecked to
hb_font_get_extents_for_direction(), which memsets it.

Substitute a stack local at function entry with the existing
`if (!p) p = &local;` idiom (cf. hb-paint.cc), so every path below is
unchanged, and drop the now-redundant `if (extents)` guard.  ...2() is
covered through its callee.  The prototype comment becomes
`/* OUT.  May be NULL. */` to match hb_ot_metrics_get_position().  No
API/ABI change.

Regression cases are added to test/api/test-ot-metrics.c and
test/api/test-base-minmax.c.

Reported by Anthropic's OSS Scanner as ordinary bug ANT-2026-Y1S3T3RY.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-10-30 16:35:27 -06:00

128 lines
5.3 KiB
C

/*
* Copyright © 2018 Ebrahim Byagowi
*
* 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.
*/
#include "hb-test.h"
#include <hb-ot.h>
#include <math.h>
/* Unit tests for hb-ot-metrics.h */
static void
test_ot_metrics_get_no_var (void)
{
hb_face_t *face = hb_test_open_font_file ("fonts/cpal-v0.ttf");
hb_font_t *font = hb_font_create (face);
hb_position_t value;
g_assert_true (hb_ot_metrics_get_position (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER, &value));
g_assert_cmpint (value, ==, 1000);
g_assert_cmpint (hb_ot_metrics_get_x_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
g_assert_cmpint (hb_ot_metrics_get_y_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
g_assert_cmpint (hb_ot_metrics_get_x_variation (font, HB_OT_METRICS_TAG_X_HEIGHT), ==, 0);
// g_assert_cmpint ((int) hb_ot_metrics_get_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
hb_font_destroy (font);
hb_face_destroy (face);
}
static void
test_ot_metrics_get_var (void)
{
hb_face_t *face = hb_test_open_font_file ("fonts/TestCFF2VF.otf");
hb_font_t *font = hb_font_create (face);
hb_position_t value;
g_assert_true (hb_ot_metrics_get_position (font, HB_OT_METRICS_TAG_X_HEIGHT, &value));
g_assert_cmpint (value, ==, 486);
g_assert_cmpint (hb_ot_metrics_get_x_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
g_assert_cmpint (hb_ot_metrics_get_y_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
g_assert_cmpint (hb_ot_metrics_get_x_variation (font, HB_OT_METRICS_TAG_X_HEIGHT), ==, 0);
float coords[] = {100.f};
hb_font_set_var_coords_design (font, coords, 1);
g_assert_true (hb_ot_metrics_get_position (font, HB_OT_METRICS_TAG_X_HEIGHT, &value));
g_assert_cmpint (value, ==, 478);
g_assert_cmpint (hb_ot_metrics_get_x_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
g_assert_cmpint (hb_ot_metrics_get_y_variation (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER), ==, 0);
g_assert_cmpint (hb_ot_metrics_get_x_variation (font, HB_OT_METRICS_TAG_X_HEIGHT), ==, -8);
hb_font_destroy (font);
hb_face_destroy (face);
}
static void
test_ot_metrics_get_with_fallback (void)
{
/* No vhea table: vertical metrics are synthesized. */
hb_face_t *face = hb_test_open_font_file ("fonts/Roboto-Regular.abc.ttf");
hb_font_t *font = hb_font_create (face);
hb_font_extents_t extents;
hb_position_t value;
g_assert_false (hb_ot_metrics_get_position (font, HB_OT_METRICS_TAG_VERTICAL_ASCENDER, &value));
g_assert_false (hb_ot_metrics_get_position (font, HB_OT_METRICS_TAG_VERTICAL_DESCENDER, &value));
hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &extents);
g_assert_cmpint (extents.ascender, !=, extents.descender);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_VERTICAL_ASCENDER, &value);
g_assert_cmpint (value, ==, extents.ascender);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_VERTICAL_DESCENDER, &value);
g_assert_cmpint (value, ==, extents.descender);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_VERTICAL_LINE_GAP, &value);
g_assert_cmpint (value, ==, extents.line_gap);
hb_font_destroy (font);
hb_face_destroy (face);
}
static void
test_ot_metrics_get_position_with_fallback_null (void)
{
hb_face_t *face = hb_test_open_font_file ("fonts/cpal-v0.ttf");
hb_font_t *font = hb_font_create (face);
hb_position_t value;
/* position may be NULL whether the metric is found, found but zero, or synthesized. */
g_assert_true (hb_ot_metrics_get_position (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER, NULL));
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER, NULL);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_UNDERLINE_SIZE, NULL);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_VERTICAL_ASCENDER, NULL);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_X_HEIGHT, NULL);
hb_ot_metrics_get_position_with_fallback (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER, &value);
g_assert_cmpint (value, ==, 1000);
hb_font_destroy (font);
hb_face_destroy (face);
}
int
main (int argc, char **argv)
{
hb_test_init (&argc, &argv);
hb_test_add (test_ot_metrics_get_no_var);
hb_test_add (test_ot_metrics_get_var);
hb_test_add (test_ot_metrics_get_with_fallback);
hb_test_add (test_ot_metrics_get_position_with_fallback_null);
return hb_test_run ();
}