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_DEPRECATED_FOR (hb_ot_layout_table_select_script)
  71 HB_EXTERN hb_bool_t
  72 hb_ot_layout_table_choose_script (hb_face_t      *face,
  73                                   hb_tag_t        table_tag,
  74                                   const hb_tag_t *script_tags,
  75                                   unsigned int   *script_index,
  76                                   hb_tag_t       *chosen_script);
  77
  78 HB_DEPRECATED_FOR (hb_ot_layout_script_select_language)
  79 HB_EXTERN hb_bool_t
  80 hb_ot_layout_script_find_language (hb_face_t    *face,
  81                                    hb_tag_t      table_tag,
  82                                    unsigned int  script_index,
  83                                    hb_tag_t      language_tag,
  84                                    unsigned int *language_index);
  85
  86 HB_DEPRECATED_FOR (hb_ot_tags_from_script_and_language)
  87 HB_EXTERN void
  88 hb_ot_tags_from_script (hb_script_t  script,
  89                         hb_tag_t    *script_tag_1,
  90                         hb_tag_t    *script_tag_2);
  91
  92 HB_DEPRECATED_FOR (hb_ot_tags_from_script_and_language)
  93 HB_EXTERN hb_tag_t
  94 hb_ot_tag_from_language (hb_language_t language);
  95
  96
  97 /**
  98  * HB_OT_VAR_NO_AXIS_INDEX:
  99  *
 100  * Do not use.
 101  *
 102  * Since: 1.4.2
 103  * Deprecated: 2.2.0
 104  */
 105 #define HB_OT_VAR_NO_AXIS_INDEX         0xFFFFFFFFu
 106
 107 /**
 108  * hb_ot_var_axis_t:
 109  * @tag: axis tag
 110  * @name_id: axis name identifier
 111  * @min_value: minimum value of the axis
 112  * @default_value: default value of the axis
 113  * @max_value: maximum value of the axis
 114  *
 115  * Use #hb_ot_var_axis_info_t instead.
 116  *
 117  * Since: 1.4.2
 118  * Deprecated: 2.2.0
 119  */
 120 typedef struct hb_ot_var_axis_t {
 121   hb_tag_t tag;
 122   hb_ot_name_id_t name_id;
 123   float min_value;
 124   float default_value;
 125   float max_value;
 126 } hb_ot_var_axis_t;
 127
 128 HB_DEPRECATED_FOR (hb_ot_var_get_axis_infos)
 129 HB_EXTERN unsigned int
 130 hb_ot_var_get_axes (hb_face_t        *face,
 131                     unsigned int      start_offset,
 132                     unsigned int     *axes_count /* IN/OUT */,
 133                     hb_ot_var_axis_t *axes_array /* OUT */);
 134
 135 HB_DEPRECATED_FOR (hb_ot_var_find_axis_info)
 136 HB_EXTERN hb_bool_t
 137 hb_ot_var_find_axis (hb_face_t        *face,
 138                      hb_tag_t          axis_tag,
 139                      unsigned int     *axis_index,
 140                      hb_ot_var_axis_t *axis_info);
 141
 142
 143 #endif
 144
 145 HB_END_DECLS
 146
 147 #endif /* HB_OT_DEPRECATED_H */