1 /* 2 * Copyright © 2013 Google, Inc. 3 * 4 * This is part of HarfBuzz, a text shaping library. 5 * 6 * Permission is hereby granted, without written agreement and without 7 * license or royalty fees, to use, copy, modify, and distribute this 8 * software and its documentation for any purpose, provided that the 9 * above copyright notice and the following two paragraphs appear in 10 * all copies of this software. 11 * 12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR 13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES 14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN 15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 16 * DAMAGE. 17 * 18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, 19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS 21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO 22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 23 * 24 * Google Author(s): Behdad Esfahbod 25 */ 26 27 #if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR) 28 #error "Include <hb.h> instead." 29 #endif 30 31 #ifndef HB_DEPRECATED_H 32 #define HB_DEPRECATED_H 33 34 #include "hb-common.h" 35 #include "hb-unicode.h" 36 #include "hb-font.h" 37 #include "hb-set.h" 38 39 40 /** 41 * SECTION:hb-deprecated 42 * @title: hb-deprecated 43 * @short_description: Deprecated API 44 * @include: hb.h 45 * 46 * These API have been deprecated in favor of newer API, or because they 47 * were deemed unnecessary. 48 **/ 49 50 51 HB_BEGIN_DECLS 52 53 #ifndef HB_DISABLE_DEPRECATED 54 55 56 /** 57 * HB_SCRIPT_CANADIAN_ABORIGINAL: 58 * 59 * Use #HB_SCRIPT_CANADIAN_SYLLABICS instead: 60 * 61 * Deprecated: 0.9.20 62 */ 63 #define HB_SCRIPT_CANADIAN_ABORIGINAL HB_SCRIPT_CANADIAN_SYLLABICS 64 65 /** 66 * HB_BUFFER_FLAGS_DEFAULT: 67 * 68 * Use #HB_BUFFER_FLAG_DEFAULT instead. 69 * 70 * Deprecated: 0.9.20 71 */ 72 #define HB_BUFFER_FLAGS_DEFAULT HB_BUFFER_FLAG_DEFAULT 73 /** 74 * HB_BUFFER_SERIALIZE_FLAGS_DEFAULT: 75 * 76 * Use #HB_BUFFER_SERIALIZE_FLAG_DEFAULT instead. 77 * 78 * Deprecated: 0.9.20 79 */ 80 #define HB_BUFFER_SERIALIZE_FLAGS_DEFAULT HB_BUFFER_SERIALIZE_FLAG_DEFAULT 81 82 /** 83 * hb_font_get_glyph_func_t: 84 * @font: #hb_font_t to work upon 85 * @font_data: @font user data pointer 86 * @unicode: The Unicode code point to query 87 * @variation_selector: The variation-selector code point to query 88 * @glyph: (out): The glyph ID retrieved 89 * @user_data: User data pointer passed by the caller 90 * 91 * A virtual method for the #hb_font_funcs_t of an #hb_font_t object. 92 * 93 * This method should retrieve the glyph ID for a specified Unicode code point 94 * font, with an optional variation selector. 95 * 96 * Return value: %true if data found, %false otherwise 97 * Deprecated: 1.2.3 98 * 99 **/ 100 typedef hb_bool_t (*hb_font_get_glyph_func_t) (hb_font_t *font, void *font_data, 101 hb_codepoint_t unicode, hb_codepoint_t variation_selector, 102 hb_codepoint_t *glyph, 103 void *user_data); 104 105 HB_EXTERN HB_DEPRECATED_FOR(hb_font_funcs_set_nominal_glyph_func and hb_font_funcs_set_variation_glyph_func) void 106 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs, 107 hb_font_get_glyph_func_t func, 108 void *user_data, hb_destroy_func_t destroy); 109 110 /** 111 * hb_unicode_eastasian_width_func_t: 112 * @ufuncs: A Unicode-functions structure 113 * @unicode: The code point to query 114 * @user_data: User data pointer passed by the caller 115 * 116 * A virtual method for the #hb_unicode_funcs_t structure. 117 * 118 * Deprecated: 2.0.0 119 */ 120 typedef unsigned int (*hb_unicode_eastasian_width_func_t) (hb_unicode_funcs_t *ufuncs, 121 hb_codepoint_t unicode, 122 void *user_data); 123 124 /** 125 * hb_unicode_funcs_set_eastasian_width_func: 126 * @ufuncs: a Unicode-function structure 127 * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign 128 * @user_data: Data to pass to @func 129 * @destroy: (nullable): The function to call when @user_data is not needed anymore 130 * 131 * Sets the implementation function for #hb_unicode_eastasian_width_func_t. 132 * 133 * Since: 0.9.2 134 * Deprecated: 2.0.0 135 **/ 136 HB_EXTERN HB_DEPRECATED void 137 hb_unicode_funcs_set_eastasian_width_func (hb_unicode_funcs_t *ufuncs, 138 hb_unicode_eastasian_width_func_t func, 139 void *user_data, hb_destroy_func_t destroy); 140 141 /** 142 * hb_unicode_eastasian_width: 143 * @ufuncs: a Unicode-function structure 144 * @unicode: The code point to query 145 * 146 * Don't use. Not used by HarfBuzz. 147 * 148 * Since: 0.9.2 149 * Deprecated: 2.0.0 150 **/ 151 HB_EXTERN HB_DEPRECATED unsigned int 152 hb_unicode_eastasian_width (hb_unicode_funcs_t *ufuncs, 153 hb_codepoint_t unicode); 154 155 156 /** 157 * hb_unicode_decompose_compatibility_func_t: 158 * @ufuncs: a Unicode function structure 159 * @u: codepoint to decompose 160 * @decomposed: address of codepoint array (of length #HB_UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into 161 * @user_data: user data pointer as passed to hb_unicode_funcs_set_decompose_compatibility_func() 162 * 163 * Fully decompose @u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to @decomposed. 164 * The complete length of the decomposition will be returned. 165 * 166 * If @u has no compatibility decomposition, zero should be returned. 167 * 168 * The Unicode standard guarantees that a buffer of length #HB_UNICODE_MAX_DECOMPOSITION_LEN codepoints will always be sufficient for any 169 * compatibility decomposition plus an terminating value of 0. Consequently, @decompose must be allocated by the caller to be at least this length. Implementations 170 * of this function type must ensure that they do not write past the provided array. 171 * 172 * Return value: number of codepoints in the full compatibility decomposition of @u, or 0 if no decomposition available. 173 * 174 * Deprecated: 2.0.0 175 */ 176 typedef unsigned int (*hb_unicode_decompose_compatibility_func_t) (hb_unicode_funcs_t *ufuncs, 177 hb_codepoint_t u, 178 hb_codepoint_t *decomposed, 179 void *user_data); 180 181 /** 182 * HB_UNICODE_MAX_DECOMPOSITION_LEN: 183 * 184 * See Unicode 6.1 for details on the maximum decomposition length. 185 * 186 * Deprecated: 2.0.0 187 */ 188 #define HB_UNICODE_MAX_DECOMPOSITION_LEN (18+1) /* codepoints */ 189 190 /** 191 * hb_unicode_funcs_set_decompose_compatibility_func: 192 * @ufuncs: A Unicode-functions structure 193 * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign 194 * @user_data: Data to pass to @func 195 * @destroy: (nullable): The function to call when @user_data is not needed anymore 196 * 197 * Sets the implementation function for #hb_unicode_decompose_compatibility_func_t. 198 * 199 * 200 * 201 * Since: 0.9.2 202 * Deprecated: 2.0.0 203 **/ 204 HB_EXTERN HB_DEPRECATED void 205 hb_unicode_funcs_set_decompose_compatibility_func (hb_unicode_funcs_t *ufuncs, 206 hb_unicode_decompose_compatibility_func_t func, 207 void *user_data, hb_destroy_func_t destroy); 208 209 HB_EXTERN HB_DEPRECATED unsigned int 210 hb_unicode_decompose_compatibility (hb_unicode_funcs_t *ufuncs, 211 hb_codepoint_t u, 212 hb_codepoint_t *decomposed); 213 214 215 /** 216 * hb_font_get_glyph_v_kerning_func_t: 217 * 218 * A virtual method for the #hb_font_funcs_t of an #hb_font_t object. 219 * 220 * This method should retrieve the kerning-adjustment value for a glyph-pair in 221 * the specified font, for vertical text segments. 222 * 223 **/ 224 typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_v_kerning_func_t; 225 226 /** 227 * hb_font_funcs_set_glyph_v_kerning_func: 228 * @ffuncs: A font-function structure 229 * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign 230 * @user_data: Data to pass to @func 231 * @destroy: (nullable): The function to call when @user_data is not needed anymore 232 * 233 * Sets the implementation function for #hb_font_get_glyph_v_kerning_func_t. 234 * 235 * Since: 0.9.2 236 * Deprecated: 2.0.0 237 **/ 238 HB_EXTERN void 239 hb_font_funcs_set_glyph_v_kerning_func (hb_font_funcs_t *ffuncs, 240 hb_font_get_glyph_v_kerning_func_t func, 241 void *user_data, hb_destroy_func_t destroy); 242 243 HB_EXTERN hb_position_t 244 hb_font_get_glyph_v_kerning (hb_font_t *font, 245 hb_codepoint_t top_glyph, hb_codepoint_t bottom_glyph); 246 247 #endif 248 249 HB_END_DECLS 250 251 #endif /* HB_DEPRECATED_H */ 252