5192ff73e3936cd7a954773ecebef9a2bc275ca0
[platform/upstream/harfbuzz.git] / src / hb-ot-deprecated.h
1 /*
2  * Copyright © 2018  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_OT_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
28 #error "Include <hb-ot.h> instead."
29 #endif
30
31 #ifndef HB_OT_DEPRECATED_H
32 #define HB_OT_DEPRECATED_H
33
34 #include "hb.h"
35 #include "hb-ot-name.h"
36
37
38 HB_BEGIN_DECLS
39
40 #ifndef HB_DISABLE_DEPRECATED
41
42
43 /* https://github.com/harfbuzz/harfbuzz/issues/1734 */
44 /**
45  * HB_MATH_GLYPH_PART_FLAG_EXTENDER:
46  *
47  * Use #HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER instead.
48  *
49  * Deprecated: 2.5.1
50  */
51 #define HB_MATH_GLYPH_PART_FLAG_EXTENDER HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER
52
53 /* https://github.com/harfbuzz/harfbuzz/pull/3417 */
54 /**
55  * HB_OT_MATH_SCRIPT:
56  *
57  * Use #HB_SCRIPT_MATH or #HB_OT_TAG_MATH_SCRIPT instead.
58  *
59  * <note>Previous versions of this documentation recommended passing
60  * #HB_OT_MATH_SCRIPT to hb_buffer_set_script() to enable math shaping, but this
61  * usage is no longer supported. Use #HB_SCRIPT_MATH instead.</note>
62  *
63  * Since: 1.3.3
64  * Deprecated: 3.4.0
65  */
66 #define HB_OT_MATH_SCRIPT HB_OT_TAG_MATH_SCRIPT
67
68
69 /* Like hb_ot_layout_table_find_script, but takes zero-terminated array of scripts to test */
70 HB_EXTERN HB_DEPRECATED_FOR (hb_ot_layout_table_select_script) hb_bool_t
71 hb_ot_layout_table_choose_script (hb_face_t      *face,
72                                   hb_tag_t        table_tag,
73                                   const hb_tag_t *script_tags,
74                                   unsigned int   *script_index,
75                                   hb_tag_t       *chosen_script);
76
77 HB_EXTERN HB_DEPRECATED_FOR (hb_ot_layout_script_select_language) hb_bool_t
78 hb_ot_layout_script_find_language (hb_face_t    *face,
79                                    hb_tag_t      table_tag,
80                                    unsigned int  script_index,
81                                    hb_tag_t      language_tag,
82                                    unsigned int *language_index);
83
84 HB_EXTERN HB_DEPRECATED_FOR (hb_ot_tags_from_script_and_language) void
85 hb_ot_tags_from_script (hb_script_t  script,
86                         hb_tag_t    *script_tag_1,
87                         hb_tag_t    *script_tag_2);
88
89 HB_EXTERN HB_DEPRECATED_FOR (hb_ot_tags_from_script_and_language) hb_tag_t
90 hb_ot_tag_from_language (hb_language_t language);
91
92
93 /**
94  * HB_OT_VAR_NO_AXIS_INDEX:
95  *
96  * Do not use.
97  *
98  * Since: 1.4.2
99  * Deprecated: 2.2.0
100  */
101 #define HB_OT_VAR_NO_AXIS_INDEX         0xFFFFFFFFu
102
103 /**
104  * hb_ot_var_axis_t:
105  * @tag: axis tag
106  * @name_id: axis name identifier
107  * @min_value: minimum value of the axis
108  * @default_value: default value of the axis
109  * @max_value: maximum value of the axis
110  *
111  * Use #hb_ot_var_axis_info_t instead.
112  *
113  * Since: 1.4.2
114  * Deprecated: 2.2.0
115  */
116 typedef struct hb_ot_var_axis_t {
117   hb_tag_t tag;
118   hb_ot_name_id_t name_id;
119   float min_value;
120   float default_value;
121   float max_value;
122 } hb_ot_var_axis_t;
123
124 HB_EXTERN HB_DEPRECATED_FOR (hb_ot_var_get_axis_infos) unsigned int
125 hb_ot_var_get_axes (hb_face_t        *face,
126                     unsigned int      start_offset,
127                     unsigned int     *axes_count /* IN/OUT */,
128                     hb_ot_var_axis_t *axes_array /* OUT */);
129
130 HB_EXTERN HB_DEPRECATED_FOR (hb_ot_var_find_axis_info) hb_bool_t
131 hb_ot_var_find_axis (hb_face_t        *face,
132                      hb_tag_t          axis_tag,
133                      unsigned int     *axis_index,
134                      hb_ot_var_axis_t *axis_info);
135
136
137 #endif
138
139 HB_END_DECLS
140
141 #endif /* HB_OT_DEPRECATED_H */