Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/harfbuzz/hb-ot-math.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 /*
jpayne@69 2 * Copyright © 2016 Igalia S.L.
jpayne@69 3 *
jpayne@69 4 * This is part of HarfBuzz, a text shaping library.
jpayne@69 5 *
jpayne@69 6 * Permission is hereby granted, without written agreement and without
jpayne@69 7 * license or royalty fees, to use, copy, modify, and distribute this
jpayne@69 8 * software and its documentation for any purpose, provided that the
jpayne@69 9 * above copyright notice and the following two paragraphs appear in
jpayne@69 10 * all copies of this software.
jpayne@69 11 *
jpayne@69 12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
jpayne@69 13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
jpayne@69 14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
jpayne@69 15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
jpayne@69 16 * DAMAGE.
jpayne@69 17 *
jpayne@69 18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
jpayne@69 19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
jpayne@69 20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
jpayne@69 21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
jpayne@69 22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
jpayne@69 23 *
jpayne@69 24 * Igalia Author(s): Frédéric Wang
jpayne@69 25 */
jpayne@69 26
jpayne@69 27 #ifndef HB_OT_H_IN
jpayne@69 28 #error "Include <hb-ot.h> instead."
jpayne@69 29 #endif
jpayne@69 30
jpayne@69 31 #ifndef HB_OT_MATH_H
jpayne@69 32 #define HB_OT_MATH_H
jpayne@69 33
jpayne@69 34 #include "hb.h"
jpayne@69 35
jpayne@69 36 HB_BEGIN_DECLS
jpayne@69 37
jpayne@69 38
jpayne@69 39 /*
jpayne@69 40 * MATH
jpayne@69 41 */
jpayne@69 42
jpayne@69 43 #define HB_OT_TAG_MATH HB_TAG('M','A','T','H')
jpayne@69 44
jpayne@69 45 /* Use with hb_buffer_set_script() for math shaping. */
jpayne@69 46 #define HB_OT_MATH_SCRIPT HB_TAG('m','a','t','h')
jpayne@69 47
jpayne@69 48 /* Types */
jpayne@69 49
jpayne@69 50 /**
jpayne@69 51 * hb_ot_math_constant_t:
jpayne@69 52 *
jpayne@69 53 * The 'MATH' table constants specified at
jpayne@69 54 * https://docs.microsoft.com/en-us/typography/opentype/spec/math
jpayne@69 55 *
jpayne@69 56 * Since: 1.3.3
jpayne@69 57 */
jpayne@69 58 typedef enum {
jpayne@69 59 HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN = 0,
jpayne@69 60 HB_OT_MATH_CONSTANT_SCRIPT_SCRIPT_PERCENT_SCALE_DOWN = 1,
jpayne@69 61 HB_OT_MATH_CONSTANT_DELIMITED_SUB_FORMULA_MIN_HEIGHT = 2,
jpayne@69 62 HB_OT_MATH_CONSTANT_DISPLAY_OPERATOR_MIN_HEIGHT = 3,
jpayne@69 63 HB_OT_MATH_CONSTANT_MATH_LEADING = 4,
jpayne@69 64 HB_OT_MATH_CONSTANT_AXIS_HEIGHT = 5,
jpayne@69 65 HB_OT_MATH_CONSTANT_ACCENT_BASE_HEIGHT = 6,
jpayne@69 66 HB_OT_MATH_CONSTANT_FLATTENED_ACCENT_BASE_HEIGHT = 7,
jpayne@69 67 HB_OT_MATH_CONSTANT_SUBSCRIPT_SHIFT_DOWN = 8,
jpayne@69 68 HB_OT_MATH_CONSTANT_SUBSCRIPT_TOP_MAX = 9,
jpayne@69 69 HB_OT_MATH_CONSTANT_SUBSCRIPT_BASELINE_DROP_MIN = 10,
jpayne@69 70 HB_OT_MATH_CONSTANT_SUPERSCRIPT_SHIFT_UP = 11,
jpayne@69 71 HB_OT_MATH_CONSTANT_SUPERSCRIPT_SHIFT_UP_CRAMPED = 12,
jpayne@69 72 HB_OT_MATH_CONSTANT_SUPERSCRIPT_BOTTOM_MIN = 13,
jpayne@69 73 HB_OT_MATH_CONSTANT_SUPERSCRIPT_BASELINE_DROP_MAX = 14,
jpayne@69 74 HB_OT_MATH_CONSTANT_SUB_SUPERSCRIPT_GAP_MIN = 15,
jpayne@69 75 HB_OT_MATH_CONSTANT_SUPERSCRIPT_BOTTOM_MAX_WITH_SUBSCRIPT = 16,
jpayne@69 76 HB_OT_MATH_CONSTANT_SPACE_AFTER_SCRIPT = 17,
jpayne@69 77 HB_OT_MATH_CONSTANT_UPPER_LIMIT_GAP_MIN = 18,
jpayne@69 78 HB_OT_MATH_CONSTANT_UPPER_LIMIT_BASELINE_RISE_MIN = 19,
jpayne@69 79 HB_OT_MATH_CONSTANT_LOWER_LIMIT_GAP_MIN = 20,
jpayne@69 80 HB_OT_MATH_CONSTANT_LOWER_LIMIT_BASELINE_DROP_MIN = 21,
jpayne@69 81 HB_OT_MATH_CONSTANT_STACK_TOP_SHIFT_UP = 22,
jpayne@69 82 HB_OT_MATH_CONSTANT_STACK_TOP_DISPLAY_STYLE_SHIFT_UP = 23,
jpayne@69 83 HB_OT_MATH_CONSTANT_STACK_BOTTOM_SHIFT_DOWN = 24,
jpayne@69 84 HB_OT_MATH_CONSTANT_STACK_BOTTOM_DISPLAY_STYLE_SHIFT_DOWN = 25,
jpayne@69 85 HB_OT_MATH_CONSTANT_STACK_GAP_MIN = 26,
jpayne@69 86 HB_OT_MATH_CONSTANT_STACK_DISPLAY_STYLE_GAP_MIN = 27,
jpayne@69 87 HB_OT_MATH_CONSTANT_STRETCH_STACK_TOP_SHIFT_UP = 28,
jpayne@69 88 HB_OT_MATH_CONSTANT_STRETCH_STACK_BOTTOM_SHIFT_DOWN = 29,
jpayne@69 89 HB_OT_MATH_CONSTANT_STRETCH_STACK_GAP_ABOVE_MIN = 30,
jpayne@69 90 HB_OT_MATH_CONSTANT_STRETCH_STACK_GAP_BELOW_MIN = 31,
jpayne@69 91 HB_OT_MATH_CONSTANT_FRACTION_NUMERATOR_SHIFT_UP = 32,
jpayne@69 92 HB_OT_MATH_CONSTANT_FRACTION_NUMERATOR_DISPLAY_STYLE_SHIFT_UP = 33,
jpayne@69 93 HB_OT_MATH_CONSTANT_FRACTION_DENOMINATOR_SHIFT_DOWN = 34,
jpayne@69 94 HB_OT_MATH_CONSTANT_FRACTION_DENOMINATOR_DISPLAY_STYLE_SHIFT_DOWN = 35,
jpayne@69 95 HB_OT_MATH_CONSTANT_FRACTION_NUMERATOR_GAP_MIN = 36,
jpayne@69 96 HB_OT_MATH_CONSTANT_FRACTION_NUM_DISPLAY_STYLE_GAP_MIN = 37,
jpayne@69 97 HB_OT_MATH_CONSTANT_FRACTION_RULE_THICKNESS = 38,
jpayne@69 98 HB_OT_MATH_CONSTANT_FRACTION_DENOMINATOR_GAP_MIN = 39,
jpayne@69 99 HB_OT_MATH_CONSTANT_FRACTION_DENOM_DISPLAY_STYLE_GAP_MIN = 40,
jpayne@69 100 HB_OT_MATH_CONSTANT_SKEWED_FRACTION_HORIZONTAL_GAP = 41,
jpayne@69 101 HB_OT_MATH_CONSTANT_SKEWED_FRACTION_VERTICAL_GAP = 42,
jpayne@69 102 HB_OT_MATH_CONSTANT_OVERBAR_VERTICAL_GAP = 43,
jpayne@69 103 HB_OT_MATH_CONSTANT_OVERBAR_RULE_THICKNESS = 44,
jpayne@69 104 HB_OT_MATH_CONSTANT_OVERBAR_EXTRA_ASCENDER = 45,
jpayne@69 105 HB_OT_MATH_CONSTANT_UNDERBAR_VERTICAL_GAP = 46,
jpayne@69 106 HB_OT_MATH_CONSTANT_UNDERBAR_RULE_THICKNESS = 47,
jpayne@69 107 HB_OT_MATH_CONSTANT_UNDERBAR_EXTRA_DESCENDER = 48,
jpayne@69 108 HB_OT_MATH_CONSTANT_RADICAL_VERTICAL_GAP = 49,
jpayne@69 109 HB_OT_MATH_CONSTANT_RADICAL_DISPLAY_STYLE_VERTICAL_GAP = 50,
jpayne@69 110 HB_OT_MATH_CONSTANT_RADICAL_RULE_THICKNESS = 51,
jpayne@69 111 HB_OT_MATH_CONSTANT_RADICAL_EXTRA_ASCENDER = 52,
jpayne@69 112 HB_OT_MATH_CONSTANT_RADICAL_KERN_BEFORE_DEGREE = 53,
jpayne@69 113 HB_OT_MATH_CONSTANT_RADICAL_KERN_AFTER_DEGREE = 54,
jpayne@69 114 HB_OT_MATH_CONSTANT_RADICAL_DEGREE_BOTTOM_RAISE_PERCENT = 55
jpayne@69 115 } hb_ot_math_constant_t;
jpayne@69 116
jpayne@69 117 /**
jpayne@69 118 * hb_ot_math_kern_t:
jpayne@69 119 *
jpayne@69 120 * The math kerning-table types defined for the four corners
jpayne@69 121 * of a glyph.
jpayne@69 122 *
jpayne@69 123 * Since: 1.3.3
jpayne@69 124 */
jpayne@69 125 typedef enum {
jpayne@69 126 HB_OT_MATH_KERN_TOP_RIGHT = 0,
jpayne@69 127 HB_OT_MATH_KERN_TOP_LEFT = 1,
jpayne@69 128 HB_OT_MATH_KERN_BOTTOM_RIGHT = 2,
jpayne@69 129 HB_OT_MATH_KERN_BOTTOM_LEFT = 3
jpayne@69 130 } hb_ot_math_kern_t;
jpayne@69 131
jpayne@69 132 /**
jpayne@69 133 * hb_ot_math_glyph_variant_t:
jpayne@69 134 * @glyph: The glyph index of the variant
jpayne@69 135 * @advance: The advance width of the variant
jpayne@69 136 *
jpayne@69 137 * Data type to hold math-variant information for a glyph.
jpayne@69 138 *
jpayne@69 139 * Since: 1.3.3
jpayne@69 140 */
jpayne@69 141 typedef struct hb_ot_math_glyph_variant_t {
jpayne@69 142 hb_codepoint_t glyph;
jpayne@69 143 hb_position_t advance;
jpayne@69 144 } hb_ot_math_glyph_variant_t;
jpayne@69 145
jpayne@69 146 /**
jpayne@69 147 * hb_ot_math_glyph_part_flags_t:
jpayne@69 148 *
jpayne@69 149 * Flags for math glyph parts.
jpayne@69 150 *
jpayne@69 151 * Since: 1.3.3
jpayne@69 152 */
jpayne@69 153 typedef enum { /*< flags >*/
jpayne@69 154 HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER = 0x00000001u /* Extender glyph */
jpayne@69 155 } hb_ot_math_glyph_part_flags_t;
jpayne@69 156
jpayne@69 157 /**
jpayne@69 158 * hb_ot_math_glyph_part_t:
jpayne@69 159 * @glyph: The glyph index of the variant part
jpayne@69 160 * @start_connector_length: The length of the connector on the starting side of the variant part
jpayne@69 161 * @end_connector_length: The length of the connector on the ending side of the variant part
jpayne@69 162 * @full_advance: The total advance of the part
jpayne@69 163 * @flags: #hb_ot_math_glyph_part_flags_t flags for the part
jpayne@69 164 *
jpayne@69 165 * Data type to hold information for a "part" component of a math-variant glyph.
jpayne@69 166 * Large variants for stretchable math glyphs (such as parentheses) can be constructed
jpayne@69 167 * on the fly from parts.
jpayne@69 168 *
jpayne@69 169 * Since: 1.3.3
jpayne@69 170 */
jpayne@69 171 typedef struct hb_ot_math_glyph_part_t {
jpayne@69 172 hb_codepoint_t glyph;
jpayne@69 173 hb_position_t start_connector_length;
jpayne@69 174 hb_position_t end_connector_length;
jpayne@69 175 hb_position_t full_advance;
jpayne@69 176 hb_ot_math_glyph_part_flags_t flags;
jpayne@69 177 } hb_ot_math_glyph_part_t;
jpayne@69 178
jpayne@69 179 /* Methods */
jpayne@69 180
jpayne@69 181 HB_EXTERN hb_bool_t
jpayne@69 182 hb_ot_math_has_data (hb_face_t *face);
jpayne@69 183
jpayne@69 184 HB_EXTERN hb_position_t
jpayne@69 185 hb_ot_math_get_constant (hb_font_t *font,
jpayne@69 186 hb_ot_math_constant_t constant);
jpayne@69 187
jpayne@69 188 HB_EXTERN hb_position_t
jpayne@69 189 hb_ot_math_get_glyph_italics_correction (hb_font_t *font,
jpayne@69 190 hb_codepoint_t glyph);
jpayne@69 191
jpayne@69 192 HB_EXTERN hb_position_t
jpayne@69 193 hb_ot_math_get_glyph_top_accent_attachment (hb_font_t *font,
jpayne@69 194 hb_codepoint_t glyph);
jpayne@69 195
jpayne@69 196 HB_EXTERN hb_bool_t
jpayne@69 197 hb_ot_math_is_glyph_extended_shape (hb_face_t *face,
jpayne@69 198 hb_codepoint_t glyph);
jpayne@69 199
jpayne@69 200 HB_EXTERN hb_position_t
jpayne@69 201 hb_ot_math_get_glyph_kerning (hb_font_t *font,
jpayne@69 202 hb_codepoint_t glyph,
jpayne@69 203 hb_ot_math_kern_t kern,
jpayne@69 204 hb_position_t correction_height);
jpayne@69 205
jpayne@69 206 HB_EXTERN unsigned int
jpayne@69 207 hb_ot_math_get_glyph_variants (hb_font_t *font,
jpayne@69 208 hb_codepoint_t glyph,
jpayne@69 209 hb_direction_t direction,
jpayne@69 210 unsigned int start_offset,
jpayne@69 211 unsigned int *variants_count, /* IN/OUT */
jpayne@69 212 hb_ot_math_glyph_variant_t *variants /* OUT */);
jpayne@69 213
jpayne@69 214 HB_EXTERN hb_position_t
jpayne@69 215 hb_ot_math_get_min_connector_overlap (hb_font_t *font,
jpayne@69 216 hb_direction_t direction);
jpayne@69 217
jpayne@69 218 HB_EXTERN unsigned int
jpayne@69 219 hb_ot_math_get_glyph_assembly (hb_font_t *font,
jpayne@69 220 hb_codepoint_t glyph,
jpayne@69 221 hb_direction_t direction,
jpayne@69 222 unsigned int start_offset,
jpayne@69 223 unsigned int *parts_count, /* IN/OUT */
jpayne@69 224 hb_ot_math_glyph_part_t *parts, /* OUT */
jpayne@69 225 hb_position_t *italics_correction /* OUT */);
jpayne@69 226
jpayne@69 227
jpayne@69 228 HB_END_DECLS
jpayne@69 229
jpayne@69 230 #endif /* HB_OT_MATH_H */