jpayne@69: /* jpayne@69: * Copyright © 2016 Igalia S.L. jpayne@69: * jpayne@69: * This is part of HarfBuzz, a text shaping library. jpayne@69: * jpayne@69: * Permission is hereby granted, without written agreement and without jpayne@69: * license or royalty fees, to use, copy, modify, and distribute this jpayne@69: * software and its documentation for any purpose, provided that the jpayne@69: * above copyright notice and the following two paragraphs appear in jpayne@69: * all copies of this software. jpayne@69: * jpayne@69: * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR jpayne@69: * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES jpayne@69: * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN jpayne@69: * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH jpayne@69: * DAMAGE. jpayne@69: * jpayne@69: * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, jpayne@69: * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND jpayne@69: * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS jpayne@69: * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO jpayne@69: * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. jpayne@69: * jpayne@69: * Igalia Author(s): Frédéric Wang jpayne@69: */ jpayne@69: jpayne@69: #ifndef HB_OT_H_IN jpayne@69: #error "Include instead." jpayne@69: #endif jpayne@69: jpayne@69: #ifndef HB_OT_MATH_H jpayne@69: #define HB_OT_MATH_H jpayne@69: jpayne@69: #include "hb.h" jpayne@69: jpayne@69: HB_BEGIN_DECLS jpayne@69: jpayne@69: jpayne@69: /* jpayne@69: * MATH jpayne@69: */ jpayne@69: jpayne@69: #define HB_OT_TAG_MATH HB_TAG('M','A','T','H') jpayne@69: jpayne@69: /* Use with hb_buffer_set_script() for math shaping. */ jpayne@69: #define HB_OT_MATH_SCRIPT HB_TAG('m','a','t','h') jpayne@69: jpayne@69: /* Types */ jpayne@69: jpayne@69: /** jpayne@69: * hb_ot_math_constant_t: jpayne@69: * jpayne@69: * The 'MATH' table constants specified at jpayne@69: * https://docs.microsoft.com/en-us/typography/opentype/spec/math jpayne@69: * jpayne@69: * Since: 1.3.3 jpayne@69: */ jpayne@69: typedef enum { jpayne@69: HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN = 0, jpayne@69: HB_OT_MATH_CONSTANT_SCRIPT_SCRIPT_PERCENT_SCALE_DOWN = 1, jpayne@69: HB_OT_MATH_CONSTANT_DELIMITED_SUB_FORMULA_MIN_HEIGHT = 2, jpayne@69: HB_OT_MATH_CONSTANT_DISPLAY_OPERATOR_MIN_HEIGHT = 3, jpayne@69: HB_OT_MATH_CONSTANT_MATH_LEADING = 4, jpayne@69: HB_OT_MATH_CONSTANT_AXIS_HEIGHT = 5, jpayne@69: HB_OT_MATH_CONSTANT_ACCENT_BASE_HEIGHT = 6, jpayne@69: HB_OT_MATH_CONSTANT_FLATTENED_ACCENT_BASE_HEIGHT = 7, jpayne@69: HB_OT_MATH_CONSTANT_SUBSCRIPT_SHIFT_DOWN = 8, jpayne@69: HB_OT_MATH_CONSTANT_SUBSCRIPT_TOP_MAX = 9, jpayne@69: HB_OT_MATH_CONSTANT_SUBSCRIPT_BASELINE_DROP_MIN = 10, jpayne@69: HB_OT_MATH_CONSTANT_SUPERSCRIPT_SHIFT_UP = 11, jpayne@69: HB_OT_MATH_CONSTANT_SUPERSCRIPT_SHIFT_UP_CRAMPED = 12, jpayne@69: HB_OT_MATH_CONSTANT_SUPERSCRIPT_BOTTOM_MIN = 13, jpayne@69: HB_OT_MATH_CONSTANT_SUPERSCRIPT_BASELINE_DROP_MAX = 14, jpayne@69: HB_OT_MATH_CONSTANT_SUB_SUPERSCRIPT_GAP_MIN = 15, jpayne@69: HB_OT_MATH_CONSTANT_SUPERSCRIPT_BOTTOM_MAX_WITH_SUBSCRIPT = 16, jpayne@69: HB_OT_MATH_CONSTANT_SPACE_AFTER_SCRIPT = 17, jpayne@69: HB_OT_MATH_CONSTANT_UPPER_LIMIT_GAP_MIN = 18, jpayne@69: HB_OT_MATH_CONSTANT_UPPER_LIMIT_BASELINE_RISE_MIN = 19, jpayne@69: HB_OT_MATH_CONSTANT_LOWER_LIMIT_GAP_MIN = 20, jpayne@69: HB_OT_MATH_CONSTANT_LOWER_LIMIT_BASELINE_DROP_MIN = 21, jpayne@69: HB_OT_MATH_CONSTANT_STACK_TOP_SHIFT_UP = 22, jpayne@69: HB_OT_MATH_CONSTANT_STACK_TOP_DISPLAY_STYLE_SHIFT_UP = 23, jpayne@69: HB_OT_MATH_CONSTANT_STACK_BOTTOM_SHIFT_DOWN = 24, jpayne@69: HB_OT_MATH_CONSTANT_STACK_BOTTOM_DISPLAY_STYLE_SHIFT_DOWN = 25, jpayne@69: HB_OT_MATH_CONSTANT_STACK_GAP_MIN = 26, jpayne@69: HB_OT_MATH_CONSTANT_STACK_DISPLAY_STYLE_GAP_MIN = 27, jpayne@69: HB_OT_MATH_CONSTANT_STRETCH_STACK_TOP_SHIFT_UP = 28, jpayne@69: HB_OT_MATH_CONSTANT_STRETCH_STACK_BOTTOM_SHIFT_DOWN = 29, jpayne@69: HB_OT_MATH_CONSTANT_STRETCH_STACK_GAP_ABOVE_MIN = 30, jpayne@69: HB_OT_MATH_CONSTANT_STRETCH_STACK_GAP_BELOW_MIN = 31, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_NUMERATOR_SHIFT_UP = 32, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_NUMERATOR_DISPLAY_STYLE_SHIFT_UP = 33, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_DENOMINATOR_SHIFT_DOWN = 34, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_DENOMINATOR_DISPLAY_STYLE_SHIFT_DOWN = 35, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_NUMERATOR_GAP_MIN = 36, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_NUM_DISPLAY_STYLE_GAP_MIN = 37, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_RULE_THICKNESS = 38, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_DENOMINATOR_GAP_MIN = 39, jpayne@69: HB_OT_MATH_CONSTANT_FRACTION_DENOM_DISPLAY_STYLE_GAP_MIN = 40, jpayne@69: HB_OT_MATH_CONSTANT_SKEWED_FRACTION_HORIZONTAL_GAP = 41, jpayne@69: HB_OT_MATH_CONSTANT_SKEWED_FRACTION_VERTICAL_GAP = 42, jpayne@69: HB_OT_MATH_CONSTANT_OVERBAR_VERTICAL_GAP = 43, jpayne@69: HB_OT_MATH_CONSTANT_OVERBAR_RULE_THICKNESS = 44, jpayne@69: HB_OT_MATH_CONSTANT_OVERBAR_EXTRA_ASCENDER = 45, jpayne@69: HB_OT_MATH_CONSTANT_UNDERBAR_VERTICAL_GAP = 46, jpayne@69: HB_OT_MATH_CONSTANT_UNDERBAR_RULE_THICKNESS = 47, jpayne@69: HB_OT_MATH_CONSTANT_UNDERBAR_EXTRA_DESCENDER = 48, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_VERTICAL_GAP = 49, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_DISPLAY_STYLE_VERTICAL_GAP = 50, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_RULE_THICKNESS = 51, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_EXTRA_ASCENDER = 52, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_KERN_BEFORE_DEGREE = 53, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_KERN_AFTER_DEGREE = 54, jpayne@69: HB_OT_MATH_CONSTANT_RADICAL_DEGREE_BOTTOM_RAISE_PERCENT = 55 jpayne@69: } hb_ot_math_constant_t; jpayne@69: jpayne@69: /** jpayne@69: * hb_ot_math_kern_t: jpayne@69: * jpayne@69: * The math kerning-table types defined for the four corners jpayne@69: * of a glyph. jpayne@69: * jpayne@69: * Since: 1.3.3 jpayne@69: */ jpayne@69: typedef enum { jpayne@69: HB_OT_MATH_KERN_TOP_RIGHT = 0, jpayne@69: HB_OT_MATH_KERN_TOP_LEFT = 1, jpayne@69: HB_OT_MATH_KERN_BOTTOM_RIGHT = 2, jpayne@69: HB_OT_MATH_KERN_BOTTOM_LEFT = 3 jpayne@69: } hb_ot_math_kern_t; jpayne@69: jpayne@69: /** jpayne@69: * hb_ot_math_glyph_variant_t: jpayne@69: * @glyph: The glyph index of the variant jpayne@69: * @advance: The advance width of the variant jpayne@69: * jpayne@69: * Data type to hold math-variant information for a glyph. jpayne@69: * jpayne@69: * Since: 1.3.3 jpayne@69: */ jpayne@69: typedef struct hb_ot_math_glyph_variant_t { jpayne@69: hb_codepoint_t glyph; jpayne@69: hb_position_t advance; jpayne@69: } hb_ot_math_glyph_variant_t; jpayne@69: jpayne@69: /** jpayne@69: * hb_ot_math_glyph_part_flags_t: jpayne@69: * jpayne@69: * Flags for math glyph parts. jpayne@69: * jpayne@69: * Since: 1.3.3 jpayne@69: */ jpayne@69: typedef enum { /*< flags >*/ jpayne@69: HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER = 0x00000001u /* Extender glyph */ jpayne@69: } hb_ot_math_glyph_part_flags_t; jpayne@69: jpayne@69: /** jpayne@69: * hb_ot_math_glyph_part_t: jpayne@69: * @glyph: The glyph index of the variant part jpayne@69: * @start_connector_length: The length of the connector on the starting side of the variant part jpayne@69: * @end_connector_length: The length of the connector on the ending side of the variant part jpayne@69: * @full_advance: The total advance of the part jpayne@69: * @flags: #hb_ot_math_glyph_part_flags_t flags for the part jpayne@69: * jpayne@69: * Data type to hold information for a "part" component of a math-variant glyph. jpayne@69: * Large variants for stretchable math glyphs (such as parentheses) can be constructed jpayne@69: * on the fly from parts. jpayne@69: * jpayne@69: * Since: 1.3.3 jpayne@69: */ jpayne@69: typedef struct hb_ot_math_glyph_part_t { jpayne@69: hb_codepoint_t glyph; jpayne@69: hb_position_t start_connector_length; jpayne@69: hb_position_t end_connector_length; jpayne@69: hb_position_t full_advance; jpayne@69: hb_ot_math_glyph_part_flags_t flags; jpayne@69: } hb_ot_math_glyph_part_t; jpayne@69: jpayne@69: /* Methods */ jpayne@69: jpayne@69: HB_EXTERN hb_bool_t jpayne@69: hb_ot_math_has_data (hb_face_t *face); jpayne@69: jpayne@69: HB_EXTERN hb_position_t jpayne@69: hb_ot_math_get_constant (hb_font_t *font, jpayne@69: hb_ot_math_constant_t constant); jpayne@69: jpayne@69: HB_EXTERN hb_position_t jpayne@69: hb_ot_math_get_glyph_italics_correction (hb_font_t *font, jpayne@69: hb_codepoint_t glyph); jpayne@69: jpayne@69: HB_EXTERN hb_position_t jpayne@69: hb_ot_math_get_glyph_top_accent_attachment (hb_font_t *font, jpayne@69: hb_codepoint_t glyph); jpayne@69: jpayne@69: HB_EXTERN hb_bool_t jpayne@69: hb_ot_math_is_glyph_extended_shape (hb_face_t *face, jpayne@69: hb_codepoint_t glyph); jpayne@69: jpayne@69: HB_EXTERN hb_position_t jpayne@69: hb_ot_math_get_glyph_kerning (hb_font_t *font, jpayne@69: hb_codepoint_t glyph, jpayne@69: hb_ot_math_kern_t kern, jpayne@69: hb_position_t correction_height); jpayne@69: jpayne@69: HB_EXTERN unsigned int jpayne@69: hb_ot_math_get_glyph_variants (hb_font_t *font, jpayne@69: hb_codepoint_t glyph, jpayne@69: hb_direction_t direction, jpayne@69: unsigned int start_offset, jpayne@69: unsigned int *variants_count, /* IN/OUT */ jpayne@69: hb_ot_math_glyph_variant_t *variants /* OUT */); jpayne@69: jpayne@69: HB_EXTERN hb_position_t jpayne@69: hb_ot_math_get_min_connector_overlap (hb_font_t *font, jpayne@69: hb_direction_t direction); jpayne@69: jpayne@69: HB_EXTERN unsigned int jpayne@69: hb_ot_math_get_glyph_assembly (hb_font_t *font, jpayne@69: hb_codepoint_t glyph, jpayne@69: hb_direction_t direction, jpayne@69: unsigned int start_offset, jpayne@69: unsigned int *parts_count, /* IN/OUT */ jpayne@69: hb_ot_math_glyph_part_t *parts, /* OUT */ jpayne@69: hb_position_t *italics_correction /* OUT */); jpayne@69: jpayne@69: jpayne@69: HB_END_DECLS jpayne@69: jpayne@69: #endif /* HB_OT_MATH_H */