annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/harfbuzz/hb-deprecated.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 /*
jpayne@69 2 * Copyright © 2013 Google, Inc.
jpayne@69 3 *
jpayne@69 4 * This is part of HarfBuzz, a text shaping library.
jpayne@69 5 *
jpayne@69 6 * Permission is hereby granted, without written agreement and without
jpayne@69 7 * license or royalty fees, to use, copy, modify, and distribute this
jpayne@69 8 * software and its documentation for any purpose, provided that the
jpayne@69 9 * above copyright notice and the following two paragraphs appear in
jpayne@69 10 * all copies of this software.
jpayne@69 11 *
jpayne@69 12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
jpayne@69 13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
jpayne@69 14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
jpayne@69 15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
jpayne@69 16 * DAMAGE.
jpayne@69 17 *
jpayne@69 18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
jpayne@69 19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
jpayne@69 20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
jpayne@69 21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
jpayne@69 22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
jpayne@69 23 *
jpayne@69 24 * Google Author(s): Behdad Esfahbod
jpayne@69 25 */
jpayne@69 26
jpayne@69 27 #ifndef HB_H_IN
jpayne@69 28 #error "Include <hb.h> instead."
jpayne@69 29 #endif
jpayne@69 30
jpayne@69 31 #ifndef HB_DEPRECATED_H
jpayne@69 32 #define HB_DEPRECATED_H
jpayne@69 33
jpayne@69 34 #include "hb-common.h"
jpayne@69 35 #include "hb-unicode.h"
jpayne@69 36 #include "hb-font.h"
jpayne@69 37 #include "hb-set.h"
jpayne@69 38
jpayne@69 39
jpayne@69 40 /**
jpayne@69 41 * SECTION:hb-deprecated
jpayne@69 42 * @title: hb-deprecated
jpayne@69 43 * @short_description: Deprecated API
jpayne@69 44 * @include: hb.h
jpayne@69 45 *
jpayne@69 46 * These API have been deprecated in favor of newer API, or because they
jpayne@69 47 * were deemed unnecessary.
jpayne@69 48 **/
jpayne@69 49
jpayne@69 50
jpayne@69 51 HB_BEGIN_DECLS
jpayne@69 52
jpayne@69 53 #ifndef HB_DISABLE_DEPRECATED
jpayne@69 54
jpayne@69 55
jpayne@69 56 #define HB_SCRIPT_CANADIAN_ABORIGINAL HB_SCRIPT_CANADIAN_SYLLABICS
jpayne@69 57
jpayne@69 58 #define HB_BUFFER_FLAGS_DEFAULT HB_BUFFER_FLAG_DEFAULT
jpayne@69 59 #define HB_BUFFER_SERIALIZE_FLAGS_DEFAULT HB_BUFFER_SERIALIZE_FLAG_DEFAULT
jpayne@69 60
jpayne@69 61 typedef hb_bool_t (*hb_font_get_glyph_func_t) (hb_font_t *font, void *font_data,
jpayne@69 62 hb_codepoint_t unicode, hb_codepoint_t variation_selector,
jpayne@69 63 hb_codepoint_t *glyph,
jpayne@69 64 void *user_data);
jpayne@69 65
jpayne@69 66 HB_EXTERN HB_DEPRECATED_FOR(hb_font_funcs_set_nominal_glyph_func and hb_font_funcs_set_variation_glyph_func) void
jpayne@69 67 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
jpayne@69 68 hb_font_get_glyph_func_t func,
jpayne@69 69 void *user_data, hb_destroy_func_t destroy);
jpayne@69 70
jpayne@69 71 HB_EXTERN HB_DEPRECATED void
jpayne@69 72 hb_set_invert (hb_set_t *set);
jpayne@69 73
jpayne@69 74 /**
jpayne@69 75 * hb_unicode_eastasian_width_func_t:
jpayne@69 76 *
jpayne@69 77 * Deprecated: 2.0.0
jpayne@69 78 */
jpayne@69 79 typedef unsigned int (*hb_unicode_eastasian_width_func_t) (hb_unicode_funcs_t *ufuncs,
jpayne@69 80 hb_codepoint_t unicode,
jpayne@69 81 void *user_data);
jpayne@69 82
jpayne@69 83 /**
jpayne@69 84 * hb_unicode_funcs_set_eastasian_width_func:
jpayne@69 85 * @ufuncs: a Unicode function structure
jpayne@69 86 * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69 87 * @user_data:
jpayne@69 88 * @destroy:
jpayne@69 89 *
jpayne@69 90 *
jpayne@69 91 *
jpayne@69 92 * Since: 0.9.2
jpayne@69 93 * Deprecated: 2.0.0
jpayne@69 94 **/
jpayne@69 95 HB_EXTERN HB_DEPRECATED void
jpayne@69 96 hb_unicode_funcs_set_eastasian_width_func (hb_unicode_funcs_t *ufuncs,
jpayne@69 97 hb_unicode_eastasian_width_func_t func,
jpayne@69 98 void *user_data, hb_destroy_func_t destroy);
jpayne@69 99
jpayne@69 100 /**
jpayne@69 101 * hb_unicode_eastasian_width:
jpayne@69 102 *
jpayne@69 103 * Since: 0.9.2
jpayne@69 104 * Deprecated: 2.0.0
jpayne@69 105 **/
jpayne@69 106 HB_EXTERN HB_DEPRECATED unsigned int
jpayne@69 107 hb_unicode_eastasian_width (hb_unicode_funcs_t *ufuncs,
jpayne@69 108 hb_codepoint_t unicode);
jpayne@69 109
jpayne@69 110
jpayne@69 111 /**
jpayne@69 112 * hb_unicode_decompose_compatibility_func_t:
jpayne@69 113 * @ufuncs: a Unicode function structure
jpayne@69 114 * @u: codepoint to decompose
jpayne@69 115 * @decomposed: address of codepoint array (of length %HB_UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into
jpayne@69 116 * @user_data: user data pointer as passed to hb_unicode_funcs_set_decompose_compatibility_func()
jpayne@69 117 *
jpayne@69 118 * Fully decompose @u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to @decomposed.
jpayne@69 119 * The complete length of the decomposition will be returned.
jpayne@69 120 *
jpayne@69 121 * If @u has no compatibility decomposition, zero should be returned.
jpayne@69 122 *
jpayne@69 123 * The Unicode standard guarantees that a buffer of length %HB_UNICODE_MAX_DECOMPOSITION_LEN codepoints will always be sufficient for any
jpayne@69 124 * compatibility decomposition plus an terminating value of 0. Consequently, @decompose must be allocated by the caller to be at least this length. Implementations
jpayne@69 125 * of this function type must ensure that they do not write past the provided array.
jpayne@69 126 *
jpayne@69 127 * Return value: number of codepoints in the full compatibility decomposition of @u, or 0 if no decomposition available.
jpayne@69 128 *
jpayne@69 129 * Deprecated: 2.0.0
jpayne@69 130 */
jpayne@69 131 typedef unsigned int (*hb_unicode_decompose_compatibility_func_t) (hb_unicode_funcs_t *ufuncs,
jpayne@69 132 hb_codepoint_t u,
jpayne@69 133 hb_codepoint_t *decomposed,
jpayne@69 134 void *user_data);
jpayne@69 135
jpayne@69 136 /**
jpayne@69 137 * HB_UNICODE_MAX_DECOMPOSITION_LEN:
jpayne@69 138 *
jpayne@69 139 * See Unicode 6.1 for details on the maximum decomposition length.
jpayne@69 140 *
jpayne@69 141 * Deprecated: 2.0.0
jpayne@69 142 */
jpayne@69 143 #define HB_UNICODE_MAX_DECOMPOSITION_LEN (18+1) /* codepoints */
jpayne@69 144
jpayne@69 145 /**
jpayne@69 146 * hb_unicode_funcs_set_decompose_compatibility_func:
jpayne@69 147 * @ufuncs: a Unicode function structure
jpayne@69 148 * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69 149 * @user_data:
jpayne@69 150 * @destroy:
jpayne@69 151 *
jpayne@69 152 *
jpayne@69 153 *
jpayne@69 154 * Since: 0.9.2
jpayne@69 155 * Deprecated: 2.0.0
jpayne@69 156 **/
jpayne@69 157 HB_EXTERN HB_DEPRECATED void
jpayne@69 158 hb_unicode_funcs_set_decompose_compatibility_func (hb_unicode_funcs_t *ufuncs,
jpayne@69 159 hb_unicode_decompose_compatibility_func_t func,
jpayne@69 160 void *user_data, hb_destroy_func_t destroy);
jpayne@69 161
jpayne@69 162 HB_EXTERN HB_DEPRECATED unsigned int
jpayne@69 163 hb_unicode_decompose_compatibility (hb_unicode_funcs_t *ufuncs,
jpayne@69 164 hb_codepoint_t u,
jpayne@69 165 hb_codepoint_t *decomposed);
jpayne@69 166
jpayne@69 167
jpayne@69 168 typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_v_kerning_func_t;
jpayne@69 169
jpayne@69 170 /**
jpayne@69 171 * hb_font_funcs_set_glyph_v_kerning_func:
jpayne@69 172 * @ffuncs: font functions.
jpayne@69 173 * @func: (closure user_data) (destroy destroy) (scope notified):
jpayne@69 174 * @user_data:
jpayne@69 175 * @destroy:
jpayne@69 176 *
jpayne@69 177 *
jpayne@69 178 *
jpayne@69 179 * Since: 0.9.2
jpayne@69 180 * Deprecated: 2.0.0
jpayne@69 181 **/
jpayne@69 182 HB_EXTERN void
jpayne@69 183 hb_font_funcs_set_glyph_v_kerning_func (hb_font_funcs_t *ffuncs,
jpayne@69 184 hb_font_get_glyph_v_kerning_func_t func,
jpayne@69 185 void *user_data, hb_destroy_func_t destroy);
jpayne@69 186
jpayne@69 187 HB_EXTERN hb_position_t
jpayne@69 188 hb_font_get_glyph_v_kerning (hb_font_t *font,
jpayne@69 189 hb_codepoint_t top_glyph, hb_codepoint_t bottom_glyph);
jpayne@69 190
jpayne@69 191 #endif
jpayne@69 192
jpayne@69 193 HB_END_DECLS
jpayne@69 194
jpayne@69 195 #endif /* HB_DEPRECATED_H */