test/api/test-font.c

   1 /*
   2  * Copyright © 2011  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-test.h"
  28
  29 /* Unit tests for hb-font.h */
  30
  31
  32 static const char test_data[] = "test\0data";
  33
  34
  35 static void
  36 test_face_empty (void)
  37 {
  38   g_assert (hb_face_get_empty ());
  39   g_assert (hb_face_get_empty () != hb_face_create (hb_blob_get_empty (), 0));
  40   g_assert (hb_face_get_empty () != hb_face_create (NULL, 0));
  41
  42   g_assert (hb_face_reference_table (hb_face_get_empty (), HB_TAG ('h','e','a','d')) == hb_blob_get_empty ());
  43
  44   g_assert_cmpint (hb_face_get_upem (hb_face_get_empty ()), ==, 1000);
  45 }
  46
  47 static void
  48 test_face_create (void)
  49 {
  50   hb_face_t *face;
  51   hb_blob_t *blob;
  52
  53   blob = hb_blob_create (test_data, sizeof (test_data), HB_MEMORY_MODE_READONLY, NULL, NULL);
  54   face = hb_face_create (blob, 0);
  55   hb_blob_destroy (blob);
  56
  57   g_assert (hb_face_reference_table (face, HB_TAG ('h','e','a','d')) == hb_blob_get_empty ());
  58
  59   g_assert_cmpint (hb_face_get_upem (face), ==, 1000);
  60
  61   hb_face_destroy (face);
  62 }
  63
  64
  65 static void
  66 free_up (void *user_data)
  67 {
  68   int *freed = (int *) user_data;
  69
  70   g_assert (!*freed);
  71
  72   (*freed)++;
  73 }
  74
  75 static hb_blob_t *
  76 get_table (hb_face_t *face, hb_tag_t tag, void *user_data)
  77 {
  78   if (tag == HB_TAG ('a','b','c','d'))
  79     return hb_blob_create (test_data, sizeof (test_data), HB_MEMORY_MODE_READONLY, NULL, NULL);
  80
  81   return hb_blob_get_empty ();
  82 }
  83
  84 static void
  85 test_face_createfortables (void)
  86 {
  87   hb_face_t *face;
  88   hb_blob_t *blob;
  89   const char *data;
  90   unsigned int len;
  91   int freed = 0;
  92
  93   face = hb_face_create_for_tables (get_table, &freed, free_up);
  94   g_assert (!freed);
  95
  96   g_assert (hb_face_reference_table (face, HB_TAG ('h','e','a','d')) == hb_blob_get_empty ());
  97
  98   blob = hb_face_reference_table (face, HB_TAG ('a','b','c','d'));
  99   g_assert (blob != hb_blob_get_empty ());
 100
 101   data = hb_blob_get_data (blob, &len);
 102   g_assert_cmpint (len, ==, sizeof (test_data));
 103   g_assert (0 == memcmp (data, test_data, sizeof (test_data)));
 104   hb_blob_destroy (blob);
 105
 106   g_assert_cmpint (hb_face_get_upem (face), ==, 1000);
 107
 108   hb_face_destroy (face);
 109   g_assert (freed);
 110 }
 111
 112 static void
 113 _test_font_nil_funcs (hb_font_t *font)
 114 {
 115   hb_codepoint_t glyph;
 116   hb_position_t x, y;
 117   hb_glyph_extents_t extents;
 118   unsigned int upem = hb_face_get_upem (hb_font_get_face (font));
 119
 120   x = y = 13;
 121   g_assert (!hb_font_get_glyph_contour_point (font, 17, 2, &x, &y));
 122   g_assert_cmpint (x, ==, 0);
 123   g_assert_cmpint (y, ==, 0);
 124
 125   x = hb_font_get_glyph_h_advance (font, 17);
 126   g_assert_cmpint (x, ==, upem);
 127
 128   extents.x_bearing = extents.y_bearing = 13;
 129   extents.width = extents.height = 15;
 130   hb_font_get_glyph_extents (font, 17, &extents);
 131   g_assert_cmpint (extents.x_bearing, ==, 0);
 132   g_assert_cmpint (extents.y_bearing, ==, 0);
 133   g_assert_cmpint (extents.width, ==, 0);
 134   g_assert_cmpint (extents.height, ==, 0);
 135
 136   glyph = 3;
 137   g_assert (!hb_font_get_glyph (font, 17, 2, &glyph));
 138   g_assert_cmpint (glyph, ==, 0);
 139
 140   x = hb_font_get_glyph_h_kerning (font, 17, 19);
 141   g_assert_cmpint (x, ==, 0);
 142 }
 143
 144 static void
 145 _test_fontfuncs_nil (hb_font_funcs_t *ffuncs)
 146 {
 147   hb_blob_t *blob;
 148   hb_face_t *face;
 149   hb_font_t *font;
 150   hb_font_t *subfont;
 151   int freed = 0;
 152
 153   blob = hb_blob_create (test_data, sizeof (test_data), HB_MEMORY_MODE_READONLY, NULL, NULL);
 154   face = hb_face_create (blob, 0);
 155   hb_blob_destroy (blob);
 156   g_assert (!hb_face_is_immutable (face));
 157   font = hb_font_create (face);
 158   g_assert (font);
 159   g_assert (hb_face_is_immutable (face));
 160   hb_face_destroy (face);
 161
 162
 163   hb_font_set_funcs (font, ffuncs, &freed, free_up);
 164   g_assert_cmpint (freed, ==, 0);
 165
 166   _test_font_nil_funcs (font);
 167
 168   subfont = hb_font_create_sub_font (font);
 169   g_assert (subfont);
 170
 171   g_assert_cmpint (freed, ==, 0);
 172   hb_font_destroy (font);
 173   g_assert_cmpint (freed, ==, 0);
 174
 175   _test_font_nil_funcs (subfont);
 176
 177   hb_font_destroy (subfont);
 178   g_assert_cmpint (freed, ==, 1);
 179 }
 180
 181 static void
 182 test_fontfuncs_empty (void)
 183 {
 184   g_assert (hb_font_funcs_get_empty ());
 185   g_assert (hb_font_funcs_is_immutable (hb_font_funcs_get_empty ()));
 186   _test_fontfuncs_nil (hb_font_funcs_get_empty ());
 187 }
 188
 189 static void
 190 test_fontfuncs_nil (void)
 191 {
 192   hb_font_funcs_t *ffuncs;
 193
 194   ffuncs = hb_font_funcs_create ();
 195
 196   g_assert (!hb_font_funcs_is_immutable (ffuncs));
 197   _test_fontfuncs_nil (hb_font_funcs_get_empty ());
 198
 199   hb_font_funcs_destroy (ffuncs);
 200 }
 201
 202 static hb_bool_t
 203 contour_point_func1 (hb_font_t *font, void *font_data,
 204                      hb_codepoint_t glyph, unsigned int point_index,
 205                      hb_position_t *x, hb_position_t *y,
 206                      void *user_data)
 207 {
 208   if (glyph == 1) {
 209     *x = 2;
 210     *y = 3;
 211     return TRUE;
 212   }
 213   if (glyph == 2) {
 214     *x = 4;
 215     *y = 5;
 216     return TRUE;
 217   }
 218
 219   return FALSE;
 220 }
 221
 222 static hb_bool_t
 223 contour_point_func2 (hb_font_t *font, void *font_data,
 224                      hb_codepoint_t glyph, unsigned int point_index,
 225                      hb_position_t *x, hb_position_t *y,
 226                      void *user_data)
 227 {
 228   if (glyph == 1) {
 229     *x = 6;
 230     *y = 7;
 231     return TRUE;
 232   }
 233
 234   return hb_font_get_glyph_contour_point (hb_font_get_parent (font),
 235                                           glyph, point_index, x, y);
 236 }
 237
 238 static hb_position_t
 239 glyph_h_advance_func1 (hb_font_t *font, void *font_data,
 240                        hb_codepoint_t glyph,
 241                        void *user_data)
 242 {
 243   if (glyph == 1)
 244     return 8;
 245
 246   return 0;
 247 }
 248
 249 static void
 250 test_fontfuncs_subclassing (void)
 251 {
 252   hb_blob_t *blob;
 253   hb_face_t *face;
 254
 255   hb_font_funcs_t *ffuncs1;
 256   hb_font_funcs_t *ffuncs2;
 257
 258   hb_font_t *font1;
 259   hb_font_t *font2;
 260   hb_font_t *font3;
 261
 262   hb_position_t x;
 263   hb_position_t y;
 264
 265   blob = hb_blob_create (test_data, sizeof (test_data), HB_MEMORY_MODE_READONLY, NULL, NULL);
 266   face = hb_face_create (blob, 0);
 267   hb_blob_destroy (blob);
 268   font1 = hb_font_create (face);
 269   hb_face_destroy (face);
 270   hb_font_set_scale (font1, 10, 10);
 271
 272   /* setup font1 */
 273   ffuncs1 = hb_font_funcs_create ();
 274   hb_font_funcs_set_glyph_contour_point_func (ffuncs1, contour_point_func1, NULL, NULL);
 275   hb_font_funcs_set_glyph_h_advance_func (ffuncs1, glyph_h_advance_func1, NULL, NULL);
 276   hb_font_set_funcs (font1, ffuncs1, NULL, NULL);
 277   hb_font_funcs_destroy (ffuncs1);
 278
 279   x = y = 1;
 280   g_assert (hb_font_get_glyph_contour_point_for_origin (font1, 1, 2, HB_DIRECTION_LTR, &x, &y));
 281   g_assert_cmpint (x, ==, 2);
 282   g_assert_cmpint (y, ==, 3);
 283   g_assert (hb_font_get_glyph_contour_point_for_origin (font1, 2, 5, HB_DIRECTION_LTR, &x, &y));
 284   g_assert_cmpint (x, ==, 4);
 285   g_assert_cmpint (y, ==, 5);
 286   g_assert (!hb_font_get_glyph_contour_point_for_origin (font1, 3, 7, HB_DIRECTION_RTL, &x, &y));
 287   g_assert_cmpint (x, ==, 0);
 288   g_assert_cmpint (y, ==, 0);
 289   x = hb_font_get_glyph_h_advance (font1, 1);
 290   g_assert_cmpint (x, ==, 8);
 291   x = hb_font_get_glyph_h_advance (font1, 2);
 292   g_assert_cmpint (x, ==, 0);
 293
 294   /* creating sub-font doesn't make the parent font immutable;
 295    * making a font immutable however makes it's lineage immutable.
 296    */
 297   font2 = hb_font_create_sub_font (font1);
 298   font3 = hb_font_create_sub_font (font2);
 299   g_assert (!hb_font_is_immutable (font1));
 300   g_assert (!hb_font_is_immutable (font2));
 301   g_assert (!hb_font_is_immutable (font3));
 302   hb_font_make_immutable (font3);
 303   g_assert (hb_font_is_immutable (font1));
 304   g_assert (hb_font_is_immutable (font2));
 305   g_assert (hb_font_is_immutable (font3));
 306   hb_font_destroy (font2);
 307   hb_font_destroy (font3);
 308
 309   font2 = hb_font_create_sub_font (font1);
 310   hb_font_destroy (font1);
 311
 312   /* setup font2 to override some funcs */
 313   ffuncs2 = hb_font_funcs_create ();
 314   hb_font_funcs_set_glyph_contour_point_func (ffuncs2, contour_point_func2, NULL, NULL);
 315   hb_font_set_funcs (font2, ffuncs2, NULL, NULL);
 316   hb_font_funcs_destroy (ffuncs2);
 317
 318   x = y = 1;
 319   g_assert (hb_font_get_glyph_contour_point_for_origin (font2, 1, 2, HB_DIRECTION_LTR, &x, &y));
 320   g_assert_cmpint (x, ==, 6);
 321   g_assert_cmpint (y, ==, 7);
 322   g_assert (hb_font_get_glyph_contour_point_for_origin (font2, 2, 5, HB_DIRECTION_RTL, &x, &y));
 323   g_assert_cmpint (x, ==, 4);
 324   g_assert_cmpint (y, ==, 5);
 325   g_assert (!hb_font_get_glyph_contour_point_for_origin (font2, 3, 7, HB_DIRECTION_LTR, &x, &y));
 326   g_assert_cmpint (x, ==, 0);
 327   g_assert_cmpint (y, ==, 0);
 328   x = hb_font_get_glyph_h_advance (font2, 1);
 329   g_assert_cmpint (x, ==, 8);
 330   x = hb_font_get_glyph_h_advance (font2, 2);
 331   g_assert_cmpint (x, ==, 0);
 332
 333   /* setup font3 to override scale */
 334   font3 = hb_font_create_sub_font (font2);
 335   hb_font_set_scale (font3, 20, 30);
 336
 337   x = y = 1;
 338   g_assert (hb_font_get_glyph_contour_point_for_origin (font3, 1, 2, HB_DIRECTION_RTL, &x, &y));
 339   g_assert_cmpint (x, ==, 6*2);
 340   g_assert_cmpint (y, ==, 7*3);
 341   g_assert (hb_font_get_glyph_contour_point_for_origin (font3, 2, 5, HB_DIRECTION_LTR, &x, &y));
 342   g_assert_cmpint (x, ==, 4*2);
 343   g_assert_cmpint (y, ==, 5*3);
 344   g_assert (!hb_font_get_glyph_contour_point_for_origin (font3, 3, 7, HB_DIRECTION_LTR, &x, &y));
 345   g_assert_cmpint (x, ==, 0*2);
 346   g_assert_cmpint (y, ==, 0*3);
 347   x = hb_font_get_glyph_h_advance (font3, 1);
 348   g_assert_cmpint (x, ==, 8*2);
 349   x = hb_font_get_glyph_h_advance (font3, 2);
 350   g_assert_cmpint (x, ==, 0*2);
 351
 352
 353   hb_font_destroy (font3);
 354 }
 355
 356
 357 static void
 358 test_font_empty (void)
 359 {
 360   g_assert (hb_font_get_empty ());
 361   g_assert (hb_font_get_empty () != hb_font_create (hb_face_get_empty ()));
 362   g_assert (hb_font_get_empty () != hb_font_create (NULL));
 363   g_assert (hb_font_get_empty () != hb_font_create_sub_font (NULL));
 364   g_assert (hb_font_is_immutable (hb_font_get_empty ()));
 365
 366   g_assert (hb_font_get_face (hb_font_get_empty ()) == hb_face_get_empty ());
 367   g_assert (hb_font_get_parent (hb_font_get_empty ()) == NULL);
 368 }
 369
 370 static void
 371 test_font_properties (void)
 372 {
 373   hb_blob_t *blob;
 374   hb_face_t *face;
 375   hb_font_t *font;
 376   hb_font_t *subfont;
 377   int x_scale, y_scale;
 378   unsigned int x_ppem, y_ppem;
 379   unsigned int upem;
 380
 381   blob = hb_blob_create (test_data, sizeof (test_data), HB_MEMORY_MODE_READONLY, NULL, NULL);
 382   face = hb_face_create (blob, 0);
 383   hb_blob_destroy (blob);
 384   font = hb_font_create (face);
 385   hb_face_destroy (face);
 386
 387
 388   g_assert (hb_font_get_face (font) == face);
 389   g_assert (hb_font_get_parent (font) == hb_font_get_empty ());
 390   subfont = hb_font_create_sub_font (font);
 391   g_assert (hb_font_get_parent (subfont) == font);
 392   hb_font_set_parent(subfont, NULL);
 393   g_assert (hb_font_get_parent (subfont) == hb_font_get_empty());
 394   hb_font_set_parent(subfont, font);
 395   g_assert (hb_font_get_parent (subfont) == font);
 396   hb_font_set_parent(subfont, NULL);
 397   hb_font_make_immutable (subfont);
 398   g_assert (hb_font_get_parent (subfont) == hb_font_get_empty());
 399   hb_font_set_parent(subfont, font);
 400   g_assert (hb_font_get_parent (subfont) == hb_font_get_empty());
 401   hb_font_destroy (subfont);
 402
 403
 404   /* Check scale */
 405
 406   upem = hb_face_get_upem (hb_font_get_face (font));
 407   hb_font_get_scale (font, NULL, NULL);
 408   x_scale = y_scale = 13;
 409   hb_font_get_scale (font, &x_scale, NULL);
 410   g_assert_cmpint (x_scale, ==, upem);
 411   x_scale = y_scale = 13;
 412   hb_font_get_scale (font, NULL, &y_scale);
 413   g_assert_cmpint (y_scale, ==, upem);
 414   x_scale = y_scale = 13;
 415   hb_font_get_scale (font, &x_scale, &y_scale);
 416   g_assert_cmpint (x_scale, ==, upem);
 417   g_assert_cmpint (y_scale, ==, upem);
 418
 419   hb_font_set_scale (font, 17, 19);
 420
 421   x_scale = y_scale = 13;
 422   hb_font_get_scale (font, &x_scale, &y_scale);
 423   g_assert_cmpint (x_scale, ==, 17);
 424   g_assert_cmpint (y_scale, ==, 19);
 425
 426
 427   /* Check ppem */
 428
 429   hb_font_get_ppem (font, NULL, NULL);
 430   x_ppem = y_ppem = 13;
 431   hb_font_get_ppem (font, &x_ppem, NULL);
 432   g_assert_cmpint (x_ppem, ==, 0);
 433   x_ppem = y_ppem = 13;
 434   hb_font_get_ppem (font, NULL, &y_ppem);
 435   g_assert_cmpint (y_ppem, ==, 0);
 436   x_ppem = y_ppem = 13;
 437   hb_font_get_ppem (font, &x_ppem, &y_ppem);
 438   g_assert_cmpint (x_ppem, ==, 0);
 439   g_assert_cmpint (y_ppem, ==, 0);
 440
 441   hb_font_set_ppem (font, 17, 19);
 442
 443   x_ppem = y_ppem = 13;
 444   hb_font_get_ppem (font, &x_ppem, &y_ppem);
 445   g_assert_cmpint (x_ppem, ==, 17);
 446   g_assert_cmpint (y_ppem, ==, 19);
 447
 448
 449   /* Check immutable */
 450
 451   g_assert (!hb_font_is_immutable (font));
 452   hb_font_make_immutable (font);
 453   g_assert (hb_font_is_immutable (font));
 454
 455   hb_font_set_scale (font, 10, 12);
 456   x_scale = y_scale = 13;
 457   hb_font_get_scale (font, &x_scale, &y_scale);
 458   g_assert_cmpint (x_scale, ==, 17);
 459   g_assert_cmpint (y_scale, ==, 19);
 460
 461   hb_font_set_ppem (font, 10, 12);
 462   x_ppem = y_ppem = 13;
 463   hb_font_get_ppem (font, &x_ppem, &y_ppem);
 464   g_assert_cmpint (x_ppem, ==, 17);
 465   g_assert_cmpint (y_ppem, ==, 19);
 466
 467
 468   /* sub_font now */
 469   subfont = hb_font_create_sub_font (font);
 470   hb_font_destroy (font);
 471
 472   g_assert (hb_font_get_parent (subfont) == font);
 473   g_assert (hb_font_get_face (subfont) == face);
 474
 475   /* scale */
 476   x_scale = y_scale = 13;
 477   hb_font_get_scale (subfont, &x_scale, &y_scale);
 478   g_assert_cmpint (x_scale, ==, 17);
 479   g_assert_cmpint (y_scale, ==, 19);
 480   hb_font_set_scale (subfont, 10, 12);
 481   x_scale = y_scale = 13;
 482   hb_font_get_scale (subfont, &x_scale, &y_scale);
 483   g_assert_cmpint (x_scale, ==, 10);
 484   g_assert_cmpint (y_scale, ==, 12);
 485   x_scale = y_scale = 13;
 486   hb_font_get_scale (font, &x_scale, &y_scale);
 487   g_assert_cmpint (x_scale, ==, 17);
 488   g_assert_cmpint (y_scale, ==, 19);
 489
 490   /* ppem */
 491   x_ppem = y_ppem = 13;
 492   hb_font_get_ppem (subfont, &x_ppem, &y_ppem);
 493   g_assert_cmpint (x_ppem, ==, 17);
 494   g_assert_cmpint (y_ppem, ==, 19);
 495   hb_font_set_ppem (subfont, 10, 12);
 496   x_ppem = y_ppem = 13;
 497   hb_font_get_ppem (subfont, &x_ppem, &y_ppem);
 498   g_assert_cmpint (x_ppem, ==, 10);
 499   g_assert_cmpint (y_ppem, ==, 12);
 500   x_ppem = y_ppem = 13;
 501   hb_font_get_ppem (font, &x_ppem, &y_ppem);
 502   g_assert_cmpint (x_ppem, ==, 17);
 503   g_assert_cmpint (y_ppem, ==, 19);
 504
 505   hb_font_destroy (subfont);
 506 }
 507
 508 int
 509 main (int argc, char **argv)
 510 {
 511   hb_test_init (&argc, &argv);
 512
 513   hb_test_add (test_face_empty);
 514   hb_test_add (test_face_create);
 515   hb_test_add (test_face_createfortables);
 516
 517   hb_test_add (test_fontfuncs_empty);
 518   hb_test_add (test_fontfuncs_nil);
 519   hb_test_add (test_fontfuncs_subclassing);
 520
 521   hb_test_add (test_font_empty);
 522   hb_test_add (test_font_properties);
 523
 524   return hb_test_run();
 525 }