/src/harfbuzz/src/hb-ot-metrics.cc

Source (jump to first uncovered line)
/*
 * Copyright © 2018-2019  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.hh"

#include "hb-ot-var-mvar-table.hh"
#include "hb-ot-gasp-table.hh" // Just so we compile it; unused otherwise.
#include "hb-ot-os2-table.hh"
#include "hb-ot-post-table.hh"
#include "hb-ot-hhea-table.hh"
#include "hb-ot-metrics.hh"
#include "hb-ot-face.hh"


/**
 * SECTION:hb-ot-metrics
 * @title: hb-ot-metrics
 * @short_description: OpenType Metrics
 * @include: hb-ot.h
 *
 * Functions for fetching metrics from fonts.
 **/

static float
_fix_ascender_descender (float value, hb_ot_metrics_tag_t metrics_tag)
{
  if (metrics_tag == HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER ||
      metrics_tag == HB_OT_METRICS_TAG_VERTICAL_ASCENDER)
    return fabs ((double) value);
  if (metrics_tag == HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER ||
      metrics_tag == HB_OT_METRICS_TAG_VERTICAL_DESCENDER)
    return -fabs ((double) value);
  return value;
}

/* The common part of _get_position logic needed on hb-ot-font and here
   to be able to have slim builds without the not always needed parts */
bool
_hb_ot_metrics_get_position_common (hb_font_t           *font,
            hb_ot_metrics_tag_t  metrics_tag,
            hb_position_t       *position     /* OUT.  May be NULL. */)
{
  hb_face_t *face = font->face;
  switch ((unsigned) metrics_tag)
  {
#ifndef HB_NO_VAR
#define GET_VAR face->table.MVAR->get_var (metrics_tag, font->coords, font->num_coords)
#else
#define GET_VAR .0f
#endif
#define GET_METRIC_X(TABLE, ATTR) \
  (face->table.TABLE->has_data () && \
    ((void) (position && (*position = font->em_scalef_x (_fix_ascender_descender ( \
      face->table.TABLE->ATTR + GET_VAR, metrics_tag)))), true))
#define GET_METRIC_Y(TABLE, ATTR) \
  (face->table.TABLE->has_data () && \
    ((void) (position && (*position = font->em_scalef_y (_fix_ascender_descender ( \
      face->table.TABLE->ATTR + GET_VAR, metrics_tag)))), true))

  case HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER:
    return (face->table.OS2->use_typo_metrics () && GET_METRIC_Y (OS2, sTypoAscender)) ||
     GET_METRIC_Y (hhea, ascender);
  case HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER:
    return (face->table.OS2->use_typo_metrics () && GET_METRIC_Y (OS2, sTypoDescender)) ||
     GET_METRIC_Y (hhea, descender);
  case HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP:
    return (face->table.OS2->use_typo_metrics () && GET_METRIC_Y (OS2, sTypoLineGap)) ||
     GET_METRIC_Y (hhea, lineGap);

#ifndef HB_NO_VERTICAL
  case HB_OT_METRICS_TAG_VERTICAL_ASCENDER:  return GET_METRIC_X (vhea, ascender);
  case HB_OT_METRICS_TAG_VERTICAL_DESCENDER: return GET_METRIC_X (vhea, descender);
  case HB_OT_METRICS_TAG_VERTICAL_LINE_GAP:  return GET_METRIC_X (vhea, lineGap);
#endif

#undef GET_METRIC_Y
#undef GET_METRIC_X
#undef GET_VAR
  default:                               assert (0); return false;
  }
}

#ifndef HB_NO_METRICS

#if 0
static bool
_get_gasp (hb_face_t *face, float *result, hb_ot_metrics_tag_t metrics_tag)
{
  const OT::GaspRange& range = face->table.gasp->get_gasp_range (metrics_tag - HB_TAG ('g','s','p','0'));
  if (&range == &Null (OT::GaspRange)) return false;
  if (result) *result = range.rangeMaxPPEM + font->face->table.MVAR->get_var (metrics_tag, font->coords, font->num_coords);
  return true;
}
#endif

/* Private tags for https://github.com/harfbuzz/harfbuzz/issues/1866 */
#define _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_OS2   HB_TAG ('O','a','s','c')
#define _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_HHEA  HB_TAG ('H','a','s','c')
#define _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_OS2  HB_TAG ('O','d','s','c')
#define _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_HHEA HB_TAG ('H','d','s','c')
#define _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_OS2   HB_TAG ('O','l','g','p')
#define _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_HHEA  HB_TAG ('H','l','g','p')

/**
 * hb_ot_metrics_get_position:
 * @font: an #hb_font_t object.
 * @metrics_tag: tag of metrics value you like to fetch.
 * @position: (out) (optional): result of metrics value from the font.
 *
 * Fetches metrics value corresponding to @metrics_tag from @font.
 *
 * Returns: Whether found the requested metrics in the font.
 * Since: 2.6.0
 **/
hb_bool_t
hb_ot_metrics_get_position (hb_font_t           *font,
          hb_ot_metrics_tag_t  metrics_tag,
          hb_position_t       *position     /* OUT.  May be NULL. */)
{
  hb_face_t *face = font->face;
  switch ((unsigned) metrics_tag)
  {
  case HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER:
  case HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER:
  case HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP:
  case HB_OT_METRICS_TAG_VERTICAL_ASCENDER:
  case HB_OT_METRICS_TAG_VERTICAL_DESCENDER:
  case HB_OT_METRICS_TAG_VERTICAL_LINE_GAP:           return _hb_ot_metrics_get_position_common (font, metrics_tag, position);
#ifndef HB_NO_VAR
#define GET_VAR hb_ot_metrics_get_variation (font, metrics_tag)
#else
#define GET_VAR 0
#endif
#define GET_METRIC_X(TABLE, ATTR) \
  (face->table.TABLE->has_data () && \
    ((void) (position && (*position = font->em_scalef_x (face->table.TABLE->ATTR + GET_VAR))), true))
#define GET_METRIC_Y(TABLE, ATTR) \
  (face->table.TABLE->has_data () && \
    ((void) (position && (*position = font->em_scalef_y (face->table.TABLE->ATTR + GET_VAR))), true))
  case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_ASCENT:  return GET_METRIC_Y (OS2, usWinAscent);
  case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_DESCENT: return GET_METRIC_Y (OS2, usWinDescent);

  case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RISE:
  case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RUN:
  {
    unsigned mult = 1u;

    if (font->slant)
    {
      unsigned rise = face->table.hhea->caretSlopeRise;
      unsigned upem = face->get_upem ();
      mult = (rise && rise < upem) ? hb_min (upem / rise, 256u) : 1u;
    }

    if (metrics_tag == HB_OT_METRICS_TAG_HORIZONTAL_CARET_RISE)
    {
      bool ret = GET_METRIC_Y (hhea, caretSlopeRise);

      if (position)
  *position *= mult;

      return ret;
    }
    else
    {
      hb_position_t rise = 0;

      if (font->slant && position && GET_METRIC_Y (hhea, caretSlopeRise))
  rise = *position;

      bool ret = GET_METRIC_X (hhea, caretSlopeRun);

      if (position)
      {
  *position *= mult;

  if (font->slant)
    *position += _hb_roundf (mult * font->slant_xy * rise);
      }

      return ret;
    }
  }
  case HB_OT_METRICS_TAG_HORIZONTAL_CARET_OFFSET:     return GET_METRIC_X (hhea, caretOffset);

#ifndef HB_NO_VERTICAL
  case HB_OT_METRICS_TAG_VERTICAL_CARET_RISE:         return GET_METRIC_X (vhea, caretSlopeRise);
  case HB_OT_METRICS_TAG_VERTICAL_CARET_RUN:          return GET_METRIC_Y (vhea, caretSlopeRun);
  case HB_OT_METRICS_TAG_VERTICAL_CARET_OFFSET:       return GET_METRIC_Y (vhea, caretOffset);
#endif
  case HB_OT_METRICS_TAG_X_HEIGHT:                    return GET_METRIC_Y (OS2->v2 (), sxHeight);
  case HB_OT_METRICS_TAG_CAP_HEIGHT:                  return GET_METRIC_Y (OS2->v2 (), sCapHeight);
  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_SIZE:         return GET_METRIC_X (OS2, ySubscriptXSize);
  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_SIZE:         return GET_METRIC_Y (OS2, ySubscriptYSize);
  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_OFFSET:       return GET_METRIC_X (OS2, ySubscriptXOffset);
  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_OFFSET:       return GET_METRIC_Y (OS2, ySubscriptYOffset);
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_SIZE:       return GET_METRIC_X (OS2, ySuperscriptXSize);
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_SIZE:       return GET_METRIC_Y (OS2, ySuperscriptYSize);
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_OFFSET:     return GET_METRIC_X (OS2, ySuperscriptXOffset);
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_OFFSET:     return GET_METRIC_Y (OS2, ySuperscriptYOffset);
  case HB_OT_METRICS_TAG_STRIKEOUT_SIZE:              return GET_METRIC_Y (OS2, yStrikeoutSize);
  case HB_OT_METRICS_TAG_STRIKEOUT_OFFSET:            return GET_METRIC_Y (OS2, yStrikeoutPosition);
  case HB_OT_METRICS_TAG_UNDERLINE_SIZE:              return GET_METRIC_Y (post->table, underlineThickness);
  case HB_OT_METRICS_TAG_UNDERLINE_OFFSET:            return GET_METRIC_Y (post->table, underlinePosition);

  /* Private tags */
  case _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_OS2:    return GET_METRIC_Y (OS2, sTypoAscender);
  case _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_HHEA:   return GET_METRIC_Y (hhea, ascender);
  case _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_OS2:   return GET_METRIC_Y (OS2, sTypoDescender);
  case _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_HHEA:  return GET_METRIC_Y (hhea, descender);
  case _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_OS2:    return GET_METRIC_Y (OS2, sTypoLineGap);
  case _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_HHEA:   return GET_METRIC_Y (hhea, lineGap);
#undef GET_METRIC_Y
#undef GET_METRIC_X
#undef GET_VAR
  default:                                        return false;
  }
}

/**
 * hb_ot_metrics_get_position_with_fallback:
 * @font: an #hb_font_t object.
 * @metrics_tag: tag of metrics value you like to fetch.
 * @position: (out) (optional): result of metrics value from the font.
 *
 * Fetches metrics value corresponding to @metrics_tag from @font,
 * and synthesizes a value if it the value is missing in the font.
 *
 * Since: 4.0.0
 **/
void
hb_ot_metrics_get_position_with_fallback (hb_font_t           *font,
            hb_ot_metrics_tag_t  metrics_tag,
            hb_position_t       *position     /* OUT */)
{
  hb_font_extents_t font_extents;
  hb_codepoint_t glyph;
  hb_glyph_extents_t extents;

  if (hb_ot_metrics_get_position (font, metrics_tag, position))
    {
      if ((metrics_tag != HB_OT_METRICS_TAG_STRIKEOUT_SIZE &&
           metrics_tag != HB_OT_METRICS_TAG_UNDERLINE_SIZE) ||
          *position != 0)
        return;
    }

  switch (metrics_tag)
  {
  case HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER:
  case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_ASCENT:
    hb_font_get_extents_for_direction (font, HB_DIRECTION_LTR, &font_extents);
    *position = font_extents.ascender;
    break;

  case HB_OT_METRICS_TAG_VERTICAL_ASCENDER:
    hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &font_extents);
    *position = font_extents.ascender;
    break;

  case HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER:
  case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_DESCENT:
    hb_font_get_extents_for_direction (font, HB_DIRECTION_LTR, &font_extents);
    *position = font_extents.descender;
    break;

  case HB_OT_METRICS_TAG_VERTICAL_DESCENDER:
    hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &font_extents);
    *position = font_extents.ascender;
    break;

  case HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP:
    hb_font_get_extents_for_direction (font, HB_DIRECTION_LTR, &font_extents);
    *position = font_extents.line_gap;
    break;

  case HB_OT_METRICS_TAG_VERTICAL_LINE_GAP:
    hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &font_extents);
    *position = font_extents.line_gap;
    break;

  case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RISE:
  case HB_OT_METRICS_TAG_VERTICAL_CARET_RISE:
    *position = 1;
    break;

  case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RUN:
  case HB_OT_METRICS_TAG_VERTICAL_CARET_RUN:
    *position = 0;
    break;

  case HB_OT_METRICS_TAG_HORIZONTAL_CARET_OFFSET:
  case HB_OT_METRICS_TAG_VERTICAL_CARET_OFFSET:
    *position = 0;
    break;

  case HB_OT_METRICS_TAG_X_HEIGHT:
    if (hb_font_get_nominal_glyph (font, 'x', &glyph) &&
        hb_font_get_glyph_extents (font, glyph, &extents))
      *position = extents.y_bearing;
    else
      *position = font->y_scale / 2;
    break;

  case HB_OT_METRICS_TAG_CAP_HEIGHT:
    if (hb_font_get_nominal_glyph (font, 'O', &glyph) &&
        hb_font_get_glyph_extents (font, glyph, &extents))
      *position = extents.height + 2 * extents.y_bearing;
    else
      *position = font->y_scale * 2 / 3;
    break;

  case HB_OT_METRICS_TAG_STRIKEOUT_SIZE:
  case HB_OT_METRICS_TAG_UNDERLINE_SIZE:
    *position = font->y_scale / 18;
    break;

  case HB_OT_METRICS_TAG_STRIKEOUT_OFFSET:
    {
      hb_position_t ascender;
      hb_ot_metrics_get_position_with_fallback (font,
                                                HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER,
                                                &ascender);
      *position = ascender / 2;
    }
    break;

  case HB_OT_METRICS_TAG_UNDERLINE_OFFSET:
    *position = - font->y_scale / 18;
    break;

  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_SIZE:
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_SIZE:
    *position = font->x_scale * 10 / 12;
    break;

  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_SIZE:
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_SIZE:
    *position = font->y_scale * 10 / 12;
    break;

  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_OFFSET:
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_OFFSET:
    *position = 0;
    break;

  case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_OFFSET:
  case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_OFFSET:
    *position = font->y_scale / 5;
    break;

  case _HB_OT_METRICS_TAG_MAX_VALUE:
  default:
    *position = 0;
    break;
  }
}

#ifndef HB_NO_VAR
/**
 * hb_ot_metrics_get_variation:
 * @font: an #hb_font_t object.
 * @metrics_tag: tag of metrics value you like to fetch.
 *
 * Fetches metrics value corresponding to @metrics_tag from @font with the
 * current font variation settings applied.
 *
 * Returns: The requested metric value.
 *
 * Since: 2.6.0
 **/
float
hb_ot_metrics_get_variation (hb_font_t *font, hb_ot_metrics_tag_t metrics_tag)
{
  return font->face->table.MVAR->get_var (metrics_tag, font->coords, font->num_coords);
}

/**
 * hb_ot_metrics_get_x_variation:
 * @font: an #hb_font_t object.
 * @metrics_tag: tag of metrics value you like to fetch.
 *
 * Fetches horizontal metrics value corresponding to @metrics_tag from @font
 * with the current font variation settings applied.
 *
 * Returns: The requested metric value.
 *
 * Since: 2.6.0
 **/
hb_position_t
hb_ot_metrics_get_x_variation (hb_font_t *font, hb_ot_metrics_tag_t metrics_tag)
{
  return font->em_scalef_x (hb_ot_metrics_get_variation (font, metrics_tag));
}

/**
 * hb_ot_metrics_get_y_variation:
 * @font: an #hb_font_t object.
 * @metrics_tag: tag of metrics value you like to fetch.
 *
 * Fetches vertical metrics value corresponding to @metrics_tag from @font with
 * the current font variation settings applied.
 *
 * Returns: The requested metric value.
 *
 * Since: 2.6.0
 **/
hb_position_t
hb_ot_metrics_get_y_variation (hb_font_t *font, hb_ot_metrics_tag_t metrics_tag)
{
  return font->em_scalef_y (hb_ot_metrics_get_variation (font, metrics_tag));
}
#endif

#endif

Coverage Report

Created: 2024-01-20 12:25

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright © 2018-2019 Ebrahim Byagowi
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
25		#include "hb.hh"
26
27		#include "hb-ot-var-mvar-table.hh"
28		#include "hb-ot-gasp-table.hh" // Just so we compile it; unused otherwise.
29		#include "hb-ot-os2-table.hh"
30		#include "hb-ot-post-table.hh"
31		#include "hb-ot-hhea-table.hh"
32		#include "hb-ot-metrics.hh"
33		#include "hb-ot-face.hh"
34
35
36		/**
37		* SECTION:hb-ot-metrics
38		* @title: hb-ot-metrics
39		* @short_description: OpenType Metrics
40		* @include: hb-ot.h
41		*
42		* Functions for fetching metrics from fonts.
43		**/
44
45		static float
46		_fix_ascender_descender (float value, hb_ot_metrics_tag_t metrics_tag)
47	384k	{
48	384k	if (metrics_tag == HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER \|\|
49	384k	metrics_tag == HB_OT_METRICS_TAG_VERTICAL_ASCENDER)
50	128k	return fabs ((double) value);
51	256k	if (metrics_tag == HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER \|\|
52	256k	metrics_tag == HB_OT_METRICS_TAG_VERTICAL_DESCENDER)
53	128k	return -fabs ((double) value);
54	128k	return value;
55	256k	}
56
57		/* The common part of _get_position logic needed on hb-ot-font and here
58		to be able to have slim builds without the not always needed parts */
59		bool
60		_hb_ot_metrics_get_position_common (hb_font_t *font,
61		hb_ot_metrics_tag_t metrics_tag,
62		hb_position_t position / OUT. May be NULL. */)
63	617k	{
64	617k	hb_face_t *face = font->face;
65	617k	switch ((unsigned) metrics_tag)
66	617k	{
67	0	#ifndef HB_NO_VAR
68	384k	#define GET_VAR face->table.MVAR->get_var (metrics_tag, font->coords, font->num_coords)
69		#else
70		#define GET_VAR .0f
71		#endif
72	0	#define GET_METRIC_X(TABLE, ATTR) \
73	0	(face->table.TABLE->has_data () && \
74	0	((void) (position && (*position = font->em_scalef_x (_fix_ascender_descender ( \
75	0	face->table.TABLE->ATTR + GET_VAR, metrics_tag)))), true))
76	0	#define GET_METRIC_Y(TABLE, ATTR) \
77	617k	(face->table.TABLE->has_data () && \
78	617k	((void) (position && (*position = font->em_scalef_y (_fix_ascender_descender ( \
79	384k	face->table.TABLE->ATTR + GET_VAR, metrics_tag)))), true))
80
81	361k	case HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER:
82	361k	return (face->table.OS2->use_typo_metrics () && GET_METRIC_Y (OS2, sTypoAscender)) \|\|
83	361k	GET_METRIC_Y (hhea, ascender);
84	128k	case HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER:
85	128k	return (face->table.OS2->use_typo_metrics () && GET_METRIC_Y (OS2, sTypoDescender)) \|\|
86	128k	GET_METRIC_Y (hhea, descender);
87	128k	case HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP:
88	128k	return (face->table.OS2->use_typo_metrics () && GET_METRIC_Y (OS2, sTypoLineGap)) \|\|
89	128k	GET_METRIC_Y (hhea, lineGap);
90
91	0	#ifndef HB_NO_VERTICAL
92	0	case HB_OT_METRICS_TAG_VERTICAL_ASCENDER: return GET_METRIC_X (vhea, ascender);
93	0	case HB_OT_METRICS_TAG_VERTICAL_DESCENDER: return GET_METRIC_X (vhea, descender);
94	0	case HB_OT_METRICS_TAG_VERTICAL_LINE_GAP: return GET_METRIC_X (vhea, lineGap);
95	0	#endif
96
97	0	#undef GET_METRIC_Y
98	0	#undef GET_METRIC_X
99	0	#undef GET_VAR
100	0	default: assert (0); return false;
101	617k	}
102	617k	}
103
104		#ifndef HB_NO_METRICS
105
106		#if 0
107		static bool
108		_get_gasp (hb_face_t face, float result, hb_ot_metrics_tag_t metrics_tag)
109		{
110		const OT::GaspRange& range = face->table.gasp->get_gasp_range (metrics_tag - HB_TAG ('g','s','p','0'));
111		if (&range == &Null (OT::GaspRange)) return false;
112		if (result) *result = range.rangeMaxPPEM + font->face->table.MVAR->get_var (metrics_tag, font->coords, font->num_coords);
113		return true;
114		}
115		#endif
116
117		/* Private tags for https://github.com/harfbuzz/harfbuzz/issues/1866 */
118	0	#define _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_OS2 HB_TAG ('O','a','s','c')
119	0	#define _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_HHEA HB_TAG ('H','a','s','c')
120	0	#define _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_OS2 HB_TAG ('O','d','s','c')
121	0	#define _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_HHEA HB_TAG ('H','d','s','c')
122	0	#define _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_OS2 HB_TAG ('O','l','g','p')
123	0	#define _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_HHEA HB_TAG ('H','l','g','p')
124
125		/**
126		* hb_ot_metrics_get_position:
127		* @font: an #hb_font_t object.
128		* @metrics_tag: tag of metrics value you like to fetch.
129		* @position: (out) (optional): result of metrics value from the font.
130		*
131		* Fetches metrics value corresponding to @metrics_tag from @font.
132		*
133		* Returns: Whether found the requested metrics in the font.
134		* Since: 2.6.0
135		**/
136		hb_bool_t
137		hb_ot_metrics_get_position (hb_font_t *font,
138		hb_ot_metrics_tag_t metrics_tag,
139		hb_position_t position / OUT. May be NULL. */)
140	121k	{
141	121k	hb_face_t *face = font->face;
142	121k	switch ((unsigned) metrics_tag)
143	121k	{
144	121k	case HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER:
145	121k	case HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER:
146	121k	case HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP:
147	121k	case HB_OT_METRICS_TAG_VERTICAL_ASCENDER:
148	121k	case HB_OT_METRICS_TAG_VERTICAL_DESCENDER:
149	121k	case HB_OT_METRICS_TAG_VERTICAL_LINE_GAP: return _hb_ot_metrics_get_position_common (font, metrics_tag, position);
150	0	#ifndef HB_NO_VAR
151	0	#define GET_VAR hb_ot_metrics_get_variation (font, metrics_tag)
152		#else
153		#define GET_VAR 0
154		#endif
155	0	#define GET_METRIC_X(TABLE, ATTR) \
156	0	(face->table.TABLE->has_data () && \
157	0	((void) (position && (*position = font->em_scalef_x (face->table.TABLE->ATTR + GET_VAR))), true))
158	0	#define GET_METRIC_Y(TABLE, ATTR) \
159	0	(face->table.TABLE->has_data () && \
160	0	((void) (position && (*position = font->em_scalef_y (face->table.TABLE->ATTR + GET_VAR))), true))
161	0	case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_ASCENT: return GET_METRIC_Y (OS2, usWinAscent);
162	0	case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_DESCENT: return GET_METRIC_Y (OS2, usWinDescent);
163
164	0	case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RISE:
165	0	case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RUN:
166	0	{
167	0	unsigned mult = 1u;
168
169	0	if (font->slant)
170	0	{
171	0	unsigned rise = face->table.hhea->caretSlopeRise;
172	0	unsigned upem = face->get_upem ();
173	0	mult = (rise && rise < upem) ? hb_min (upem / rise, 256u) : 1u;
174	0	}
175
176	0	if (metrics_tag == HB_OT_METRICS_TAG_HORIZONTAL_CARET_RISE)
177	0	{
178	0	bool ret = GET_METRIC_Y (hhea, caretSlopeRise);
179
180	0	if (position)
181	0	position = mult;
182
183	0	return ret;
184	0	}
185	0	else
186	0	{
187	0	hb_position_t rise = 0;
188
189	0	if (font->slant && position && GET_METRIC_Y (hhea, caretSlopeRise))
190	0	rise = *position;
191
192	0	bool ret = GET_METRIC_X (hhea, caretSlopeRun);
193
194	0	if (position)
195	0	{
196	0	position = mult;
197
198	0	if (font->slant)
199	0	position += _hb_roundf (mult font->slant_xy * rise);
200	0	}
201
202	0	return ret;
203	0	}
204	0	}
205	0	case HB_OT_METRICS_TAG_HORIZONTAL_CARET_OFFSET: return GET_METRIC_X (hhea, caretOffset);
206
207	0	#ifndef HB_NO_VERTICAL
208	0	case HB_OT_METRICS_TAG_VERTICAL_CARET_RISE: return GET_METRIC_X (vhea, caretSlopeRise);
209	0	case HB_OT_METRICS_TAG_VERTICAL_CARET_RUN: return GET_METRIC_Y (vhea, caretSlopeRun);
210	0	case HB_OT_METRICS_TAG_VERTICAL_CARET_OFFSET: return GET_METRIC_Y (vhea, caretOffset);
211	0	#endif
212	0	case HB_OT_METRICS_TAG_X_HEIGHT: return GET_METRIC_Y (OS2->v2 (), sxHeight);
213	0	case HB_OT_METRICS_TAG_CAP_HEIGHT: return GET_METRIC_Y (OS2->v2 (), sCapHeight);
214	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_SIZE: return GET_METRIC_X (OS2, ySubscriptXSize);
215	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_SIZE: return GET_METRIC_Y (OS2, ySubscriptYSize);
216	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_OFFSET: return GET_METRIC_X (OS2, ySubscriptXOffset);
217	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_OFFSET: return GET_METRIC_Y (OS2, ySubscriptYOffset);
218	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_SIZE: return GET_METRIC_X (OS2, ySuperscriptXSize);
219	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_SIZE: return GET_METRIC_Y (OS2, ySuperscriptYSize);
220	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_OFFSET: return GET_METRIC_X (OS2, ySuperscriptXOffset);
221	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_OFFSET: return GET_METRIC_Y (OS2, ySuperscriptYOffset);
222	0	case HB_OT_METRICS_TAG_STRIKEOUT_SIZE: return GET_METRIC_Y (OS2, yStrikeoutSize);
223	0	case HB_OT_METRICS_TAG_STRIKEOUT_OFFSET: return GET_METRIC_Y (OS2, yStrikeoutPosition);
224	0	case HB_OT_METRICS_TAG_UNDERLINE_SIZE: return GET_METRIC_Y (post->table, underlineThickness);
225	0	case HB_OT_METRICS_TAG_UNDERLINE_OFFSET: return GET_METRIC_Y (post->table, underlinePosition);
226
227		/* Private tags */
228	0	case _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_OS2: return GET_METRIC_Y (OS2, sTypoAscender);
229	0	case _HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER_HHEA: return GET_METRIC_Y (hhea, ascender);
230	0	case _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_OS2: return GET_METRIC_Y (OS2, sTypoDescender);
231	0	case _HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER_HHEA: return GET_METRIC_Y (hhea, descender);
232	0	case _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_OS2: return GET_METRIC_Y (OS2, sTypoLineGap);
233	0	case _HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP_HHEA: return GET_METRIC_Y (hhea, lineGap);
234	0	#undef GET_METRIC_Y
235	0	#undef GET_METRIC_X
236	0	#undef GET_VAR
237	0	default: return false;
238	121k	}
239	121k	}
240
241		/**
242		* hb_ot_metrics_get_position_with_fallback:
243		* @font: an #hb_font_t object.
244		* @metrics_tag: tag of metrics value you like to fetch.
245		* @position: (out) (optional): result of metrics value from the font.
246		*
247		* Fetches metrics value corresponding to @metrics_tag from @font,
248		* and synthesizes a value if it the value is missing in the font.
249		*
250		* Since: 4.0.0
251		**/
252		void
253		hb_ot_metrics_get_position_with_fallback (hb_font_t *font,
254		hb_ot_metrics_tag_t metrics_tag,
255		hb_position_t position / OUT */)
256	0	{
257	0	hb_font_extents_t font_extents;
258	0	hb_codepoint_t glyph;
259	0	hb_glyph_extents_t extents;
260
261	0	if (hb_ot_metrics_get_position (font, metrics_tag, position))
262	0	{
263	0	if ((metrics_tag != HB_OT_METRICS_TAG_STRIKEOUT_SIZE &&
264	0	metrics_tag != HB_OT_METRICS_TAG_UNDERLINE_SIZE) \|\|
265	0	*position != 0)
266	0	return;
267	0	}
268
269	0	switch (metrics_tag)
270	0	{
271	0	case HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER:
272	0	case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_ASCENT:
273	0	hb_font_get_extents_for_direction (font, HB_DIRECTION_LTR, &font_extents);
274	0	*position = font_extents.ascender;
275	0	break;
276
277	0	case HB_OT_METRICS_TAG_VERTICAL_ASCENDER:
278	0	hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &font_extents);
279	0	*position = font_extents.ascender;
280	0	break;
281
282	0	case HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER:
283	0	case HB_OT_METRICS_TAG_HORIZONTAL_CLIPPING_DESCENT:
284	0	hb_font_get_extents_for_direction (font, HB_DIRECTION_LTR, &font_extents);
285	0	*position = font_extents.descender;
286	0	break;
287
288	0	case HB_OT_METRICS_TAG_VERTICAL_DESCENDER:
289	0	hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &font_extents);
290	0	*position = font_extents.ascender;
291	0	break;
292
293	0	case HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP:
294	0	hb_font_get_extents_for_direction (font, HB_DIRECTION_LTR, &font_extents);
295	0	*position = font_extents.line_gap;
296	0	break;
297
298	0	case HB_OT_METRICS_TAG_VERTICAL_LINE_GAP:
299	0	hb_font_get_extents_for_direction (font, HB_DIRECTION_TTB, &font_extents);
300	0	*position = font_extents.line_gap;
301	0	break;
302
303	0	case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RISE:
304	0	case HB_OT_METRICS_TAG_VERTICAL_CARET_RISE:
305	0	*position = 1;
306	0	break;
307
308	0	case HB_OT_METRICS_TAG_HORIZONTAL_CARET_RUN:
309	0	case HB_OT_METRICS_TAG_VERTICAL_CARET_RUN:
310	0	*position = 0;
311	0	break;
312
313	0	case HB_OT_METRICS_TAG_HORIZONTAL_CARET_OFFSET:
314	0	case HB_OT_METRICS_TAG_VERTICAL_CARET_OFFSET:
315	0	*position = 0;
316	0	break;
317
318	0	case HB_OT_METRICS_TAG_X_HEIGHT:
319	0	if (hb_font_get_nominal_glyph (font, 'x', &glyph) &&
320	0	hb_font_get_glyph_extents (font, glyph, &extents))
321	0	*position = extents.y_bearing;
322	0	else
323	0	*position = font->y_scale / 2;
324	0	break;
325
326	0	case HB_OT_METRICS_TAG_CAP_HEIGHT:
327	0	if (hb_font_get_nominal_glyph (font, 'O', &glyph) &&
328	0	hb_font_get_glyph_extents (font, glyph, &extents))
329	0	position = extents.height + 2 extents.y_bearing;
330	0	else
331	0	position = font->y_scale 2 / 3;
332	0	break;
333
334	0	case HB_OT_METRICS_TAG_STRIKEOUT_SIZE:
335	0	case HB_OT_METRICS_TAG_UNDERLINE_SIZE:
336	0	*position = font->y_scale / 18;
337	0	break;
338
339	0	case HB_OT_METRICS_TAG_STRIKEOUT_OFFSET:
340	0	{
341	0	hb_position_t ascender;
342	0	hb_ot_metrics_get_position_with_fallback (font,
343	0	HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER,
344	0	&ascender);
345	0	*position = ascender / 2;
346	0	}
347	0	break;
348
349	0	case HB_OT_METRICS_TAG_UNDERLINE_OFFSET:
350	0	*position = - font->y_scale / 18;
351	0	break;
352
353	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_SIZE:
354	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_SIZE:
355	0	position = font->x_scale 10 / 12;
356	0	break;
357
358	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_SIZE:
359	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_SIZE:
360	0	position = font->y_scale 10 / 12;
361	0	break;
362
363	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_X_OFFSET:
364	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_X_OFFSET:
365	0	*position = 0;
366	0	break;
367
368	0	case HB_OT_METRICS_TAG_SUBSCRIPT_EM_Y_OFFSET:
369	0	case HB_OT_METRICS_TAG_SUPERSCRIPT_EM_Y_OFFSET:
370	0	*position = font->y_scale / 5;
371	0	break;
372
373	0	case _HB_OT_METRICS_TAG_MAX_VALUE:
374	0	default:
375	0	*position = 0;
376	0	break;
377	0	}
378	0	}
379
380		#ifndef HB_NO_VAR
381		/**
382		* hb_ot_metrics_get_variation:
383		* @font: an #hb_font_t object.
384		* @metrics_tag: tag of metrics value you like to fetch.
385		*
386		* Fetches metrics value corresponding to @metrics_tag from @font with the
387		* current font variation settings applied.
388		*
389		* Returns: The requested metric value.
390		*
391		* Since: 2.6.0
392		**/
393		float
394		hb_ot_metrics_get_variation (hb_font_t *font, hb_ot_metrics_tag_t metrics_tag)
395	364k	{
396	364k	return font->face->table.MVAR->get_var (metrics_tag, font->coords, font->num_coords);
397	364k	}
398
399		/**
400		* hb_ot_metrics_get_x_variation:
401		* @font: an #hb_font_t object.
402		* @metrics_tag: tag of metrics value you like to fetch.
403		*
404		* Fetches horizontal metrics value corresponding to @metrics_tag from @font
405		* with the current font variation settings applied.
406		*
407		* Returns: The requested metric value.
408		*
409		* Since: 2.6.0
410		**/
411		hb_position_t
412		hb_ot_metrics_get_x_variation (hb_font_t *font, hb_ot_metrics_tag_t metrics_tag)
413	121k	{
414	121k	return font->em_scalef_x (hb_ot_metrics_get_variation (font, metrics_tag));
415	121k	}
416
417		/**
418		* hb_ot_metrics_get_y_variation:
419		* @font: an #hb_font_t object.
420		* @metrics_tag: tag of metrics value you like to fetch.
421		*
422		* Fetches vertical metrics value corresponding to @metrics_tag from @font with
423		* the current font variation settings applied.
424		*
425		* Returns: The requested metric value.
426		*
427		* Since: 2.6.0
428		**/
429		hb_position_t
430		hb_ot_metrics_get_y_variation (hb_font_t *font, hb_ot_metrics_tag_t metrics_tag)
431	121k	{
432	121k	return font->em_scalef_y (hb_ot_metrics_get_variation (font, metrics_tag));
433	121k	}
434		#endif
435
436		#endif