harfbuzz/src/hb-font.h

205 lines
5.3 KiB
C
Raw Normal View History

/*
* Copyright (C) 2009 Red Hat, Inc.
*
2010-04-22 04:11:43 +00:00
* 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.
*
* Red Hat Author(s): Behdad Esfahbod
*/
#ifndef HB_FONT_H
#define HB_FONT_H
#include "hb-common.h"
2009-08-02 01:38:39 +00:00
#include "hb-blob.h"
HB_BEGIN_DECLS
2009-08-18 22:37:36 +00:00
typedef struct _hb_face_t hb_face_t;
typedef struct _hb_font_t hb_font_t;
2009-08-02 01:38:39 +00:00
/*
2009-08-11 00:05:16 +00:00
* hb_face_t
*/
2009-08-11 00:05:16 +00:00
hb_face_t *
hb_face_create_for_data (hb_blob_t *blob,
unsigned int index);
2009-08-11 00:05:16 +00:00
typedef hb_blob_t * (*hb_get_table_func_t) (hb_tag_t tag, void *user_data);
2009-08-19 18:45:24 +00:00
/* calls destroy() when not needing user_data anymore */
2009-08-11 00:05:16 +00:00
hb_face_t *
hb_face_create_for_tables (hb_get_table_func_t get_table,
hb_destroy_func_t destroy,
void *user_data);
2009-08-11 00:05:16 +00:00
hb_face_t *
hb_face_reference (hb_face_t *face);
2009-08-11 00:05:16 +00:00
unsigned int
hb_face_get_reference_count (hb_face_t *face);
void
2009-08-11 00:05:16 +00:00
hb_face_destroy (hb_face_t *face);
2009-08-11 00:05:16 +00:00
hb_blob_t *
hb_face_get_table (hb_face_t *face,
hb_tag_t tag);
/*
2009-08-11 00:05:16 +00:00
* hb_font_funcs_t
*/
2009-08-11 00:05:16 +00:00
typedef struct _hb_font_funcs_t hb_font_funcs_t;
hb_font_funcs_t *
hb_font_funcs_create (void);
2009-08-11 00:05:16 +00:00
hb_font_funcs_t *
hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
2009-08-02 01:36:15 +00:00
unsigned int
2009-08-11 00:05:16 +00:00
hb_font_funcs_get_reference_count (hb_font_funcs_t *ffuncs);
2009-08-02 01:36:15 +00:00
void
2009-08-11 00:05:16 +00:00
hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
2009-08-11 00:05:16 +00:00
hb_font_funcs_t *
hb_font_funcs_copy (hb_font_funcs_t *ffuncs);
void
hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
2009-08-18 22:37:36 +00:00
/* funcs */
2009-11-04 01:27:05 +00:00
typedef struct _hb_glyph_metrics_t
2009-10-29 07:08:42 +00:00
{
hb_position_t x_advance;
hb_position_t y_advance;
hb_position_t x_offset;
hb_position_t y_offset;
2009-10-29 07:08:42 +00:00
hb_position_t width;
hb_position_t height;
2009-11-04 01:27:05 +00:00
} hb_glyph_metrics_t;
2009-08-18 22:37:36 +00:00
typedef hb_codepoint_t (*hb_font_get_glyph_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
2009-11-04 20:48:32 +00:00
hb_codepoint_t unicode, hb_codepoint_t variation_selector);
2009-08-18 22:37:36 +00:00
typedef hb_bool_t (*hb_font_get_contour_point_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
unsigned int point_index,
2009-08-18 22:37:36 +00:00
hb_codepoint_t glyph, hb_position_t *x, hb_position_t *y);
typedef void (*hb_font_get_glyph_metrics_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
hb_codepoint_t glyph, hb_glyph_metrics_t *metrics);
typedef hb_position_t (*hb_font_get_kerning_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
void
2009-08-11 00:05:16 +00:00
hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
hb_font_get_glyph_func_t glyph_func);
void
2009-08-11 00:05:16 +00:00
hb_font_funcs_set_contour_point_func (hb_font_funcs_t *ffuncs,
hb_font_get_contour_point_func_t contour_point_func);
void
2009-08-11 00:05:16 +00:00
hb_font_funcs_set_glyph_metrics_func (hb_font_funcs_t *ffuncs,
hb_font_get_glyph_metrics_func_t glyph_metrics_func);
void
2009-08-11 00:05:16 +00:00
hb_font_funcs_set_kerning_func (hb_font_funcs_t *ffuncs,
hb_font_get_kerning_func_t kerning_func);
2009-11-05 18:55:41 +00:00
hb_codepoint_t
hb_font_get_glyph (hb_font_t *font, hb_face_t *face,
hb_codepoint_t unicode, hb_codepoint_t variation_selector);
hb_bool_t
hb_font_get_contour_point (hb_font_t *font, hb_face_t *face,
unsigned int point_index,
hb_codepoint_t glyph, hb_position_t *x, hb_position_t *y);
void
hb_font_get_glyph_metrics (hb_font_t *font, hb_face_t *face,
hb_codepoint_t glyph, hb_glyph_metrics_t *metrics);
hb_position_t
hb_font_get_kerning (hb_font_t *font, hb_face_t *face,
hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
/*
* hb_font_t
*/
/* Fonts are very light-weight objects */
hb_font_t *
2009-08-11 00:05:16 +00:00
hb_font_create (void);
hb_font_t *
hb_font_reference (hb_font_t *font);
2009-08-02 01:36:15 +00:00
unsigned int
hb_font_get_reference_count (hb_font_t *font);
void
hb_font_destroy (hb_font_t *font);
2009-08-11 00:05:16 +00:00
void
2009-11-03 23:34:20 +00:00
hb_font_set_funcs (hb_font_t *font,
hb_font_funcs_t *klass,
hb_destroy_func_t destroy,
void *user_data);
2009-08-02 21:41:36 +00:00
2009-11-03 20:15:07 +00:00
hb_font_funcs_t *
hb_font_get_funcs (hb_font_t *font);
/*
* XXX
* should we decompose this to units_per_EM and font-size?
* units_per_EM setting then can go into the face, or better,
* read from the 'head' table.
*
* Then we either need size+shape like freetype does, or a full
* matrix.
*/
void
hb_font_set_scale (hb_font_t *font,
hb_16dot16_t x_scale,
hb_16dot16_t y_scale);
/*
* A zero value means "no hinting in that direction"
*/
void
hb_font_set_ppem (hb_font_t *font,
unsigned int x_ppem,
unsigned int y_ppem);
HB_END_DECLS
#endif /* HB_FONT_H */