jpayne@69: /* jpayne@69: * Copyright © 2009 Red Hat, Inc. jpayne@69: * Copyright © 2011 Codethink Limited jpayne@69: * Copyright © 2011,2012 Google, 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: * Codethink Author(s): Ryan Lortie jpayne@69: * Google Author(s): Behdad Esfahbod jpayne@69: */ jpayne@69: jpayne@69: #ifndef HB_H_IN jpayne@69: #error "Include instead." jpayne@69: #endif jpayne@69: jpayne@69: #ifndef HB_UNICODE_H jpayne@69: #define HB_UNICODE_H jpayne@69: jpayne@69: #include "hb-common.h" jpayne@69: jpayne@69: HB_BEGIN_DECLS jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * HB_UNICODE_MAX jpayne@69: * jpayne@69: * Since: 1.9.0 jpayne@69: **/ jpayne@69: #define HB_UNICODE_MAX 0x10FFFFu jpayne@69: jpayne@69: jpayne@69: /* hb_unicode_general_category_t */ jpayne@69: jpayne@69: /* Unicode Character Database property: General_Category (gc) */ jpayne@69: typedef enum jpayne@69: { jpayne@69: HB_UNICODE_GENERAL_CATEGORY_CONTROL, /* Cc */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_FORMAT, /* Cf */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_UNASSIGNED, /* Cn */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_PRIVATE_USE, /* Co */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_SURROGATE, /* Cs */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_LOWERCASE_LETTER, /* Ll */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_MODIFIER_LETTER, /* Lm */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_OTHER_LETTER, /* Lo */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_TITLECASE_LETTER, /* Lt */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_UPPERCASE_LETTER, /* Lu */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_SPACING_MARK, /* Mc */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK, /* Me */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK, /* Mn */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_DECIMAL_NUMBER, /* Nd */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_LETTER_NUMBER, /* Nl */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_OTHER_NUMBER, /* No */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_CONNECT_PUNCTUATION, /* Pc */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_DASH_PUNCTUATION, /* Pd */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_CLOSE_PUNCTUATION, /* Pe */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_FINAL_PUNCTUATION, /* Pf */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_INITIAL_PUNCTUATION, /* Pi */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_OTHER_PUNCTUATION, /* Po */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_OPEN_PUNCTUATION, /* Ps */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_CURRENCY_SYMBOL, /* Sc */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_MODIFIER_SYMBOL, /* Sk */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_MATH_SYMBOL, /* Sm */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_OTHER_SYMBOL, /* So */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_LINE_SEPARATOR, /* Zl */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_PARAGRAPH_SEPARATOR, /* Zp */ jpayne@69: HB_UNICODE_GENERAL_CATEGORY_SPACE_SEPARATOR /* Zs */ jpayne@69: } hb_unicode_general_category_t; jpayne@69: jpayne@69: /* hb_unicode_combining_class_t */ jpayne@69: jpayne@69: /* Note: newer versions of Unicode may add new values. Clients should be ready to handle jpayne@69: * any value in the 0..254 range being returned from hb_unicode_combining_class(). jpayne@69: */ jpayne@69: jpayne@69: /* Unicode Character Database property: Canonical_Combining_Class (ccc) */ jpayne@69: typedef enum jpayne@69: { jpayne@69: HB_UNICODE_COMBINING_CLASS_NOT_REORDERED = 0, jpayne@69: HB_UNICODE_COMBINING_CLASS_OVERLAY = 1, jpayne@69: HB_UNICODE_COMBINING_CLASS_NUKTA = 7, jpayne@69: HB_UNICODE_COMBINING_CLASS_KANA_VOICING = 8, jpayne@69: HB_UNICODE_COMBINING_CLASS_VIRAMA = 9, jpayne@69: jpayne@69: /* Hebrew */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC10 = 10, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC11 = 11, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC12 = 12, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC13 = 13, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC14 = 14, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC15 = 15, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC16 = 16, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC17 = 17, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC18 = 18, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC19 = 19, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC20 = 20, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC21 = 21, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC22 = 22, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC23 = 23, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC24 = 24, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC25 = 25, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC26 = 26, jpayne@69: jpayne@69: /* Arabic */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC27 = 27, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC28 = 28, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC29 = 29, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC30 = 30, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC31 = 31, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC32 = 32, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC33 = 33, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC34 = 34, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC35 = 35, jpayne@69: jpayne@69: /* Syriac */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC36 = 36, jpayne@69: jpayne@69: /* Telugu */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC84 = 84, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC91 = 91, jpayne@69: jpayne@69: /* Thai */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC103 = 103, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC107 = 107, jpayne@69: jpayne@69: /* Lao */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC118 = 118, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC122 = 122, jpayne@69: jpayne@69: /* Tibetan */ jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC129 = 129, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC130 = 130, jpayne@69: HB_UNICODE_COMBINING_CLASS_CCC133 = 132, jpayne@69: jpayne@69: jpayne@69: HB_UNICODE_COMBINING_CLASS_ATTACHED_BELOW_LEFT = 200, jpayne@69: HB_UNICODE_COMBINING_CLASS_ATTACHED_BELOW = 202, jpayne@69: HB_UNICODE_COMBINING_CLASS_ATTACHED_ABOVE = 214, jpayne@69: HB_UNICODE_COMBINING_CLASS_ATTACHED_ABOVE_RIGHT = 216, jpayne@69: HB_UNICODE_COMBINING_CLASS_BELOW_LEFT = 218, jpayne@69: HB_UNICODE_COMBINING_CLASS_BELOW = 220, jpayne@69: HB_UNICODE_COMBINING_CLASS_BELOW_RIGHT = 222, jpayne@69: HB_UNICODE_COMBINING_CLASS_LEFT = 224, jpayne@69: HB_UNICODE_COMBINING_CLASS_RIGHT = 226, jpayne@69: HB_UNICODE_COMBINING_CLASS_ABOVE_LEFT = 228, jpayne@69: HB_UNICODE_COMBINING_CLASS_ABOVE = 230, jpayne@69: HB_UNICODE_COMBINING_CLASS_ABOVE_RIGHT = 232, jpayne@69: HB_UNICODE_COMBINING_CLASS_DOUBLE_BELOW = 233, jpayne@69: HB_UNICODE_COMBINING_CLASS_DOUBLE_ABOVE = 234, jpayne@69: jpayne@69: HB_UNICODE_COMBINING_CLASS_IOTA_SUBSCRIPT = 240, jpayne@69: jpayne@69: HB_UNICODE_COMBINING_CLASS_INVALID = 255 jpayne@69: } hb_unicode_combining_class_t; jpayne@69: jpayne@69: jpayne@69: /* jpayne@69: * hb_unicode_funcs_t jpayne@69: */ jpayne@69: jpayne@69: typedef struct hb_unicode_funcs_t hb_unicode_funcs_t; jpayne@69: jpayne@69: jpayne@69: /* jpayne@69: * just give me the best implementation you've got there. jpayne@69: */ jpayne@69: HB_EXTERN hb_unicode_funcs_t * jpayne@69: hb_unicode_funcs_get_default (void); jpayne@69: jpayne@69: jpayne@69: HB_EXTERN hb_unicode_funcs_t * jpayne@69: hb_unicode_funcs_create (hb_unicode_funcs_t *parent); jpayne@69: jpayne@69: HB_EXTERN hb_unicode_funcs_t * jpayne@69: hb_unicode_funcs_get_empty (void); jpayne@69: jpayne@69: HB_EXTERN hb_unicode_funcs_t * jpayne@69: hb_unicode_funcs_reference (hb_unicode_funcs_t *ufuncs); jpayne@69: jpayne@69: HB_EXTERN void jpayne@69: hb_unicode_funcs_destroy (hb_unicode_funcs_t *ufuncs); jpayne@69: jpayne@69: HB_EXTERN hb_bool_t jpayne@69: hb_unicode_funcs_set_user_data (hb_unicode_funcs_t *ufuncs, 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_unicode_funcs_get_user_data (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_user_data_key_t *key); jpayne@69: jpayne@69: jpayne@69: HB_EXTERN void jpayne@69: hb_unicode_funcs_make_immutable (hb_unicode_funcs_t *ufuncs); jpayne@69: jpayne@69: HB_EXTERN hb_bool_t jpayne@69: hb_unicode_funcs_is_immutable (hb_unicode_funcs_t *ufuncs); jpayne@69: jpayne@69: HB_EXTERN hb_unicode_funcs_t * jpayne@69: hb_unicode_funcs_get_parent (hb_unicode_funcs_t *ufuncs); jpayne@69: jpayne@69: jpayne@69: /* jpayne@69: * funcs jpayne@69: */ jpayne@69: jpayne@69: /* typedefs */ jpayne@69: jpayne@69: typedef hb_unicode_combining_class_t (*hb_unicode_combining_class_func_t) (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode, jpayne@69: void *user_data); jpayne@69: typedef hb_unicode_general_category_t (*hb_unicode_general_category_func_t) (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode, jpayne@69: void *user_data); jpayne@69: typedef hb_codepoint_t (*hb_unicode_mirroring_func_t) (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode, jpayne@69: void *user_data); jpayne@69: typedef hb_script_t (*hb_unicode_script_func_t) (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode, jpayne@69: void *user_data); jpayne@69: jpayne@69: typedef hb_bool_t (*hb_unicode_compose_func_t) (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t a, jpayne@69: hb_codepoint_t b, jpayne@69: hb_codepoint_t *ab, jpayne@69: void *user_data); jpayne@69: typedef hb_bool_t (*hb_unicode_decompose_func_t) (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t ab, jpayne@69: hb_codepoint_t *a, jpayne@69: hb_codepoint_t *b, jpayne@69: void *user_data); jpayne@69: jpayne@69: /* setters */ jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_funcs_set_combining_class_func: jpayne@69: * @ufuncs: a Unicode function structure 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_unicode_funcs_set_combining_class_func (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_unicode_combining_class_func_t func, jpayne@69: void *user_data, hb_destroy_func_t destroy); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_funcs_set_general_category_func: jpayne@69: * @ufuncs: a Unicode function structure 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_unicode_funcs_set_general_category_func (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_unicode_general_category_func_t func, jpayne@69: void *user_data, hb_destroy_func_t destroy); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_funcs_set_mirroring_func: jpayne@69: * @ufuncs: a Unicode function structure 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_unicode_funcs_set_mirroring_func (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_unicode_mirroring_func_t func, jpayne@69: void *user_data, hb_destroy_func_t destroy); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_funcs_set_script_func: jpayne@69: * @ufuncs: a Unicode function structure 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_unicode_funcs_set_script_func (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_unicode_script_func_t func, jpayne@69: void *user_data, hb_destroy_func_t destroy); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_funcs_set_compose_func: jpayne@69: * @ufuncs: a Unicode function structure 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_unicode_funcs_set_compose_func (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_unicode_compose_func_t func, jpayne@69: void *user_data, hb_destroy_func_t destroy); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_funcs_set_decompose_func: jpayne@69: * @ufuncs: a Unicode function structure 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_unicode_funcs_set_decompose_func (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_unicode_decompose_func_t func, jpayne@69: void *user_data, hb_destroy_func_t destroy); jpayne@69: jpayne@69: /* accessors */ jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_combining_class: jpayne@69: * jpayne@69: * Since: 0.9.2 jpayne@69: **/ jpayne@69: HB_EXTERN hb_unicode_combining_class_t jpayne@69: hb_unicode_combining_class (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_general_category: jpayne@69: * jpayne@69: * Since: 0.9.2 jpayne@69: **/ jpayne@69: HB_EXTERN hb_unicode_general_category_t jpayne@69: hb_unicode_general_category (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_mirroring: jpayne@69: * jpayne@69: * Since: 0.9.2 jpayne@69: **/ jpayne@69: HB_EXTERN hb_codepoint_t jpayne@69: hb_unicode_mirroring (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode); jpayne@69: jpayne@69: /** jpayne@69: * hb_unicode_script: jpayne@69: * jpayne@69: * Since: 0.9.2 jpayne@69: **/ jpayne@69: HB_EXTERN hb_script_t jpayne@69: hb_unicode_script (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t unicode); jpayne@69: jpayne@69: HB_EXTERN hb_bool_t jpayne@69: hb_unicode_compose (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t a, jpayne@69: hb_codepoint_t b, jpayne@69: hb_codepoint_t *ab); jpayne@69: jpayne@69: HB_EXTERN hb_bool_t jpayne@69: hb_unicode_decompose (hb_unicode_funcs_t *ufuncs, jpayne@69: hb_codepoint_t ab, jpayne@69: hb_codepoint_t *a, jpayne@69: hb_codepoint_t *b); jpayne@69: jpayne@69: HB_END_DECLS jpayne@69: jpayne@69: #endif /* HB_UNICODE_H */