jpayne@69: /*
jpayne@69:  * Copyright © 2009  Red Hat, Inc.
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:  * Red Hat Author(s): Behdad Esfahbod
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef HB_H_IN
jpayne@69: #error "Include <hb.h> instead."
jpayne@69: #endif
jpayne@69: 
jpayne@69: #ifndef HB_FONT_H
jpayne@69: #define HB_FONT_H
jpayne@69: 
jpayne@69: #include "hb-common.h"
jpayne@69: #include "hb-face.h"
jpayne@69: #include "hb-draw.h"
jpayne@69: 
jpayne@69: HB_BEGIN_DECLS
jpayne@69: 
jpayne@69: 
jpayne@69: typedef struct hb_font_t hb_font_t;
jpayne@69: 
jpayne@69: 
jpayne@69: /*
jpayne@69:  * hb_font_funcs_t
jpayne@69:  */
jpayne@69: 
jpayne@69: typedef struct hb_font_funcs_t hb_font_funcs_t;
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_funcs_t *
jpayne@69: hb_font_funcs_create (void);
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_funcs_t *
jpayne@69: hb_font_funcs_get_empty (void);
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_funcs_t *
jpayne@69: hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_funcs_set_user_data (hb_font_funcs_t    *ffuncs,
jpayne@69: 			     hb_user_data_key_t *key,
jpayne@69: 			     void *              data,
jpayne@69: 			     hb_destroy_func_t   destroy,
jpayne@69: 			     hb_bool_t           replace);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN void *
jpayne@69: hb_font_funcs_get_user_data (hb_font_funcs_t    *ffuncs,
jpayne@69: 			     hb_user_data_key_t *key);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs);
jpayne@69: 
jpayne@69: 
jpayne@69: /* font and glyph extents */
jpayne@69: 
jpayne@69: /* Note that typically ascender is positive and descender negative in coordinate systems that grow up. */
jpayne@69: typedef struct hb_font_extents_t
jpayne@69: {
jpayne@69:   hb_position_t ascender; /* typographic ascender. */
jpayne@69:   hb_position_t descender; /* typographic descender. */
jpayne@69:   hb_position_t line_gap; /* suggested line spacing gap. */
jpayne@69:   /*< private >*/
jpayne@69:   hb_position_t reserved9;
jpayne@69:   hb_position_t reserved8;
jpayne@69:   hb_position_t reserved7;
jpayne@69:   hb_position_t reserved6;
jpayne@69:   hb_position_t reserved5;
jpayne@69:   hb_position_t reserved4;
jpayne@69:   hb_position_t reserved3;
jpayne@69:   hb_position_t reserved2;
jpayne@69:   hb_position_t reserved1;
jpayne@69: } hb_font_extents_t;
jpayne@69: 
jpayne@69: /* Note that height is negative in coordinate systems that grow up. */
jpayne@69: typedef struct hb_glyph_extents_t
jpayne@69: {
jpayne@69:   hb_position_t x_bearing; /* left side of glyph from origin. */
jpayne@69:   hb_position_t y_bearing; /* top side of glyph from origin. */
jpayne@69:   hb_position_t width; /* distance from left to right side. */
jpayne@69:   hb_position_t height; /* distance from top to bottom side. */
jpayne@69: } hb_glyph_extents_t;
jpayne@69: 
jpayne@69: /* func types */
jpayne@69: 
jpayne@69: typedef hb_bool_t (*hb_font_get_font_extents_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 						       hb_font_extents_t *extents,
jpayne@69: 						       void *user_data);
jpayne@69: typedef hb_font_get_font_extents_func_t hb_font_get_font_h_extents_func_t;
jpayne@69: typedef hb_font_get_font_extents_func_t hb_font_get_font_v_extents_func_t;
jpayne@69: 
jpayne@69: 
jpayne@69: typedef hb_bool_t (*hb_font_get_nominal_glyph_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 						       hb_codepoint_t unicode,
jpayne@69: 						       hb_codepoint_t *glyph,
jpayne@69: 						       void *user_data);
jpayne@69: typedef hb_bool_t (*hb_font_get_variation_glyph_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 							 hb_codepoint_t unicode, hb_codepoint_t variation_selector,
jpayne@69: 							 hb_codepoint_t *glyph,
jpayne@69: 							 void *user_data);
jpayne@69: 
jpayne@69: typedef unsigned int (*hb_font_get_nominal_glyphs_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 							   unsigned int count,
jpayne@69: 							   const hb_codepoint_t *first_unicode,
jpayne@69: 							   unsigned int unicode_stride,
jpayne@69: 							   hb_codepoint_t *first_glyph,
jpayne@69: 							   unsigned int glyph_stride,
jpayne@69: 							   void *user_data);
jpayne@69: 
jpayne@69: 
jpayne@69: typedef hb_position_t (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 							   hb_codepoint_t glyph,
jpayne@69: 							   void *user_data);
jpayne@69: typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_h_advance_func_t;
jpayne@69: typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_v_advance_func_t;
jpayne@69: 
jpayne@69: typedef void (*hb_font_get_glyph_advances_func_t) (hb_font_t* font, void* font_data,
jpayne@69: 						   unsigned int count,
jpayne@69: 						   const hb_codepoint_t *first_glyph,
jpayne@69: 						   unsigned glyph_stride,
jpayne@69: 						   hb_position_t *first_advance,
jpayne@69: 						   unsigned advance_stride,
jpayne@69: 						   void *user_data);
jpayne@69: typedef hb_font_get_glyph_advances_func_t hb_font_get_glyph_h_advances_func_t;
jpayne@69: typedef hb_font_get_glyph_advances_func_t hb_font_get_glyph_v_advances_func_t;
jpayne@69: 
jpayne@69: typedef hb_bool_t (*hb_font_get_glyph_origin_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 						      hb_codepoint_t glyph,
jpayne@69: 						      hb_position_t *x, hb_position_t *y,
jpayne@69: 						      void *user_data);
jpayne@69: typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_h_origin_func_t;
jpayne@69: typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_v_origin_func_t;
jpayne@69: 
jpayne@69: typedef hb_position_t (*hb_font_get_glyph_kerning_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 							   hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
jpayne@69: 							   void *user_data);
jpayne@69: typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_h_kerning_func_t;
jpayne@69: 
jpayne@69: 
jpayne@69: typedef hb_bool_t (*hb_font_get_glyph_extents_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 						       hb_codepoint_t glyph,
jpayne@69: 						       hb_glyph_extents_t *extents,
jpayne@69: 						       void *user_data);
jpayne@69: typedef hb_bool_t (*hb_font_get_glyph_contour_point_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 							     hb_codepoint_t glyph, unsigned int point_index,
jpayne@69: 							     hb_position_t *x, hb_position_t *y,
jpayne@69: 							     void *user_data);
jpayne@69: 
jpayne@69: 
jpayne@69: typedef hb_bool_t (*hb_font_get_glyph_name_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 						    hb_codepoint_t glyph,
jpayne@69: 						    char *name, unsigned int size,
jpayne@69: 						    void *user_data);
jpayne@69: typedef hb_bool_t (*hb_font_get_glyph_from_name_func_t) (hb_font_t *font, void *font_data,
jpayne@69: 							 const char *name, int len, /* -1 means nul-terminated */
jpayne@69: 							 hb_codepoint_t *glyph,
jpayne@69: 							 void *user_data);
jpayne@69: 
jpayne@69: 
jpayne@69: /* func setters */
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_font_h_extents_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 1.1.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_font_h_extents_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				       hb_font_get_font_h_extents_func_t func,
jpayne@69: 				       void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_font_v_extents_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 1.1.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_font_v_extents_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				       hb_font_get_font_v_extents_func_t func,
jpayne@69: 				       void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_nominal_glyph_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 1.2.3
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_nominal_glyph_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				      hb_font_get_nominal_glyph_func_t func,
jpayne@69: 				      void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_nominal_glyphs_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 2.0.0
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_nominal_glyphs_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				       hb_font_get_nominal_glyphs_func_t func,
jpayne@69: 				       void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_variation_glyph_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 1.2.3
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_variation_glyph_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_variation_glyph_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_h_advance_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_h_advance_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_glyph_h_advance_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_v_advance_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_v_advance_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_glyph_v_advance_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_h_advances_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 1.8.6
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_h_advances_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_glyph_h_advances_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_v_advances_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 1.8.6
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_v_advances_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_glyph_v_advances_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_h_origin_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_h_origin_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				       hb_font_get_glyph_h_origin_func_t func,
jpayne@69: 				       void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_v_origin_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_v_origin_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				       hb_font_get_glyph_v_origin_func_t func,
jpayne@69: 				       void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_h_kerning_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_h_kerning_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_glyph_h_kerning_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_extents_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				      hb_font_get_glyph_extents_func_t func,
jpayne@69: 				      void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_contour_point_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_contour_point_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					    hb_font_get_glyph_contour_point_func_t func,
jpayne@69: 					    void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_name_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_name_func (hb_font_funcs_t *ffuncs,
jpayne@69: 				   hb_font_get_glyph_name_func_t func,
jpayne@69: 				   void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_font_funcs_set_glyph_from_name_func:
jpayne@69:  * @ffuncs: font functions.
jpayne@69:  * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69:  * @user_data:
jpayne@69:  * @destroy:
jpayne@69:  *
jpayne@69:  *
jpayne@69:  *
jpayne@69:  * Since: 0.9.2
jpayne@69:  **/
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_funcs_set_glyph_from_name_func (hb_font_funcs_t *ffuncs,
jpayne@69: 					hb_font_get_glyph_from_name_func_t func,
jpayne@69: 					void *user_data, hb_destroy_func_t destroy);
jpayne@69: 
jpayne@69: /* func dispatch */
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_h_extents (hb_font_t *font,
jpayne@69: 		       hb_font_extents_t *extents);
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_v_extents (hb_font_t *font,
jpayne@69: 		       hb_font_extents_t *extents);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_nominal_glyph (hb_font_t *font,
jpayne@69: 			   hb_codepoint_t unicode,
jpayne@69: 			   hb_codepoint_t *glyph);
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_variation_glyph (hb_font_t *font,
jpayne@69: 			     hb_codepoint_t unicode, hb_codepoint_t variation_selector,
jpayne@69: 			     hb_codepoint_t *glyph);
jpayne@69: 
jpayne@69: HB_EXTERN unsigned int
jpayne@69: hb_font_get_nominal_glyphs (hb_font_t *font,
jpayne@69: 			    unsigned int count,
jpayne@69: 			    const hb_codepoint_t *first_unicode,
jpayne@69: 			    unsigned int unicode_stride,
jpayne@69: 			    hb_codepoint_t *first_glyph,
jpayne@69: 			    unsigned int glyph_stride);
jpayne@69: 
jpayne@69: HB_EXTERN hb_position_t
jpayne@69: hb_font_get_glyph_h_advance (hb_font_t *font,
jpayne@69: 			     hb_codepoint_t glyph);
jpayne@69: HB_EXTERN hb_position_t
jpayne@69: hb_font_get_glyph_v_advance (hb_font_t *font,
jpayne@69: 			     hb_codepoint_t glyph);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_glyph_h_advances (hb_font_t* font,
jpayne@69: 			      unsigned int count,
jpayne@69: 			      const hb_codepoint_t *first_glyph,
jpayne@69: 			      unsigned glyph_stride,
jpayne@69: 			      hb_position_t *first_advance,
jpayne@69: 			      unsigned advance_stride);
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_glyph_v_advances (hb_font_t* font,
jpayne@69: 			      unsigned int count,
jpayne@69: 			      const hb_codepoint_t *first_glyph,
jpayne@69: 			      unsigned glyph_stride,
jpayne@69: 			      hb_position_t *first_advance,
jpayne@69: 			      unsigned advance_stride);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_h_origin (hb_font_t *font,
jpayne@69: 			    hb_codepoint_t glyph,
jpayne@69: 			    hb_position_t *x, hb_position_t *y);
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_v_origin (hb_font_t *font,
jpayne@69: 			    hb_codepoint_t glyph,
jpayne@69: 			    hb_position_t *x, hb_position_t *y);
jpayne@69: 
jpayne@69: HB_EXTERN hb_position_t
jpayne@69: hb_font_get_glyph_h_kerning (hb_font_t *font,
jpayne@69: 			     hb_codepoint_t left_glyph, hb_codepoint_t right_glyph);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_extents (hb_font_t *font,
jpayne@69: 			   hb_codepoint_t glyph,
jpayne@69: 			   hb_glyph_extents_t *extents);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_contour_point (hb_font_t *font,
jpayne@69: 				 hb_codepoint_t glyph, unsigned int point_index,
jpayne@69: 				 hb_position_t *x, hb_position_t *y);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_name (hb_font_t *font,
jpayne@69: 			hb_codepoint_t glyph,
jpayne@69: 			char *name, unsigned int size);
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_from_name (hb_font_t *font,
jpayne@69: 			     const char *name, int len, /* -1 means nul-terminated */
jpayne@69: 			     hb_codepoint_t *glyph);
jpayne@69: 
jpayne@69: 
jpayne@69: /* high-level funcs, with fallback */
jpayne@69: 
jpayne@69: /* Calls either hb_font_get_nominal_glyph() if variation_selector is 0,
jpayne@69:  * otherwise calls hb_font_get_variation_glyph(). */
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph (hb_font_t *font,
jpayne@69: 		   hb_codepoint_t unicode, hb_codepoint_t variation_selector,
jpayne@69: 		   hb_codepoint_t *glyph);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_extents_for_direction (hb_font_t *font,
jpayne@69: 				   hb_direction_t direction,
jpayne@69: 				   hb_font_extents_t *extents);
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_glyph_advance_for_direction (hb_font_t *font,
jpayne@69: 					 hb_codepoint_t glyph,
jpayne@69: 					 hb_direction_t direction,
jpayne@69: 					 hb_position_t *x, hb_position_t *y);
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_glyph_advances_for_direction (hb_font_t* font,
jpayne@69: 					  hb_direction_t direction,
jpayne@69: 					  unsigned int count,
jpayne@69: 					  const hb_codepoint_t *first_glyph,
jpayne@69: 					  unsigned glyph_stride,
jpayne@69: 					  hb_position_t *first_advance,
jpayne@69: 					  unsigned advance_stride);
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_glyph_origin_for_direction (hb_font_t *font,
jpayne@69: 					hb_codepoint_t glyph,
jpayne@69: 					hb_direction_t direction,
jpayne@69: 					hb_position_t *x, hb_position_t *y);
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_add_glyph_origin_for_direction (hb_font_t *font,
jpayne@69: 					hb_codepoint_t glyph,
jpayne@69: 					hb_direction_t direction,
jpayne@69: 					hb_position_t *x, hb_position_t *y);
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_subtract_glyph_origin_for_direction (hb_font_t *font,
jpayne@69: 					     hb_codepoint_t glyph,
jpayne@69: 					     hb_direction_t direction,
jpayne@69: 					     hb_position_t *x, hb_position_t *y);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_glyph_kerning_for_direction (hb_font_t *font,
jpayne@69: 					 hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
jpayne@69: 					 hb_direction_t direction,
jpayne@69: 					 hb_position_t *x, hb_position_t *y);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_extents_for_origin (hb_font_t *font,
jpayne@69: 				      hb_codepoint_t glyph,
jpayne@69: 				      hb_direction_t direction,
jpayne@69: 				      hb_glyph_extents_t *extents);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_get_glyph_contour_point_for_origin (hb_font_t *font,
jpayne@69: 					    hb_codepoint_t glyph, unsigned int point_index,
jpayne@69: 					    hb_direction_t direction,
jpayne@69: 					    hb_position_t *x, hb_position_t *y);
jpayne@69: 
jpayne@69: /* Generates gidDDD if glyph has no name. */
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_glyph_to_string (hb_font_t *font,
jpayne@69: 			 hb_codepoint_t glyph,
jpayne@69: 			 char *s, unsigned int size);
jpayne@69: /* Parses gidDDD and uniUUUU strings automatically. */
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_glyph_from_string (hb_font_t *font,
jpayne@69: 			   const char *s, int len, /* -1 means nul-terminated */
jpayne@69: 			   hb_codepoint_t *glyph);
jpayne@69: 
jpayne@69: 
jpayne@69: /*
jpayne@69:  * hb_font_t
jpayne@69:  */
jpayne@69: 
jpayne@69: /* Fonts are very light-weight objects */
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_t *
jpayne@69: hb_font_create (hb_face_t *face);
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_t *
jpayne@69: hb_font_create_sub_font (hb_font_t *parent);
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_t *
jpayne@69: hb_font_get_empty (void);
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_t *
jpayne@69: hb_font_reference (hb_font_t *font);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_destroy (hb_font_t *font);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_set_user_data (hb_font_t          *font,
jpayne@69: 		       hb_user_data_key_t *key,
jpayne@69: 		       void *              data,
jpayne@69: 		       hb_destroy_func_t   destroy,
jpayne@69: 		       hb_bool_t           replace);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN void *
jpayne@69: hb_font_get_user_data (hb_font_t          *font,
jpayne@69: 		       hb_user_data_key_t *key);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_make_immutable (hb_font_t *font);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_is_immutable (hb_font_t *font);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_parent (hb_font_t *font,
jpayne@69: 		    hb_font_t *parent);
jpayne@69: 
jpayne@69: HB_EXTERN hb_font_t *
jpayne@69: hb_font_get_parent (hb_font_t *font);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_face (hb_font_t *font,
jpayne@69: 		  hb_face_t *face);
jpayne@69: 
jpayne@69: HB_EXTERN hb_face_t *
jpayne@69: hb_font_get_face (hb_font_t *font);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_funcs (hb_font_t         *font,
jpayne@69: 		   hb_font_funcs_t   *klass,
jpayne@69: 		   void              *font_data,
jpayne@69: 		   hb_destroy_func_t  destroy);
jpayne@69: 
jpayne@69: /* Be *very* careful with this function! */
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_funcs_data (hb_font_t         *font,
jpayne@69: 			void              *font_data,
jpayne@69: 			hb_destroy_func_t  destroy);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_scale (hb_font_t *font,
jpayne@69: 		   int x_scale,
jpayne@69: 		   int y_scale);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_scale (hb_font_t *font,
jpayne@69: 		   int *x_scale,
jpayne@69: 		   int *y_scale);
jpayne@69: 
jpayne@69: /*
jpayne@69:  * A zero value means "no hinting in that direction"
jpayne@69:  */
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_ppem (hb_font_t *font,
jpayne@69: 		  unsigned int x_ppem,
jpayne@69: 		  unsigned int y_ppem);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_get_ppem (hb_font_t *font,
jpayne@69: 		  unsigned int *x_ppem,
jpayne@69: 		  unsigned int *y_ppem);
jpayne@69: 
jpayne@69: /*
jpayne@69:  * Point size per EM.  Used for optical-sizing in CoreText.
jpayne@69:  * A value of zero means "not set".
jpayne@69:  */
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_ptem (hb_font_t *font, float ptem);
jpayne@69: 
jpayne@69: HB_EXTERN float
jpayne@69: hb_font_get_ptem (hb_font_t *font);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_variations (hb_font_t *font,
jpayne@69: 			const hb_variation_t *variations,
jpayne@69: 			unsigned int variations_length);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_var_coords_design (hb_font_t *font,
jpayne@69: 			       const float *coords,
jpayne@69: 			       unsigned int coords_length);
jpayne@69: 
jpayne@69: #ifdef HB_EXPERIMENTAL_API
jpayne@69: HB_EXTERN const float *
jpayne@69: hb_font_get_var_coords_design (hb_font_t *font,
jpayne@69: 			       unsigned int *length);
jpayne@69: #endif
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_var_coords_normalized (hb_font_t *font,
jpayne@69: 				   const int *coords, /* 2.14 normalized */
jpayne@69: 				   unsigned int coords_length);
jpayne@69: 
jpayne@69: HB_EXTERN const int *
jpayne@69: hb_font_get_var_coords_normalized (hb_font_t *font,
jpayne@69: 				   unsigned int *length);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_font_set_var_named_instance (hb_font_t *font,
jpayne@69: 				unsigned instance_index);
jpayne@69: 
jpayne@69: #ifdef HB_EXPERIMENTAL_API
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_font_draw_glyph (hb_font_t *font, hb_codepoint_t glyph,
jpayne@69: 		    const hb_draw_funcs_t *funcs, void *user_data);
jpayne@69: #endif
jpayne@69: 
jpayne@69: HB_END_DECLS
jpayne@69: 
jpayne@69: #endif /* HB_FONT_H */