src/hb-ot-layout.h

   1 /*
   2  * Copyright (C) 2007,2008  Red Hat, Inc.
   3  *
   4  *  This is part of HarfBuzz, an OpenType Layout engine 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  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_OT_LAYOUT_H
  28 #define HB_OT_LAYOUT_H
  29
  30 #include "hb-common.h"
  31
  32 HB_BEGIN_DECLS();
  33
  34 /*
  35  * hb_ot_layout_t
  36  */
  37
  38 typedef struct _hb_ot_layout_t hb_ot_layout_t;
  39
  40 hb_ot_layout_t *
  41 hb_ot_layout_create (void);
  42
  43 hb_ot_layout_t *
  44 hb_ot_layout_create_for_data (const char *font_data,
  45                               int         face_index);
  46
  47 void
  48 hb_ot_layout_destroy (hb_ot_layout_t *layout);
  49
  50 /* TODO sanitizing API/constructor (make_wrieable_func_t) */
  51 /* TODO get_table_func_t constructor */
  52
  53 /*
  54  * GDEF
  55  */
  56
  57 typedef enum {
  58   HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED = 0x0000,
  59   HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH   = 0x0002,
  60   HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE     = 0x0004,
  61   HB_OT_LAYOUT_GLYPH_CLASS_MARK         = 0x0008,
  62   HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT    = 0x0010
  63 } hb_ot_layout_glyph_class_t;
  64
  65 hb_bool_t
  66 hb_ot_layout_has_font_glyph_classes (hb_ot_layout_t *layout);
  67
  68 hb_ot_layout_glyph_class_t
  69 hb_ot_layout_get_glyph_class (hb_ot_layout_t *layout,
  70                               hb_codepoint_t  glyph);
  71
  72 void
  73 hb_ot_layout_set_glyph_class (hb_ot_layout_t            *layout,
  74                               hb_codepoint_t             glyph,
  75                               hb_ot_layout_glyph_class_t klass);
  76
  77 void
  78 hb_ot_layout_build_glyph_classes (hb_ot_layout_t *layout,
  79                                   uint16_t        num_total_glyphs,
  80                                   hb_codepoint_t *glyphs,
  81                                   unsigned char  *klasses,
  82                                   uint16_t        count);
  83
  84 /*
  85  * GSUB/GPOS
  86  */
  87
  88 typedef enum {
  89   HB_OT_LAYOUT_TABLE_TYPE_GSUB,
  90   HB_OT_LAYOUT_TABLE_TYPE_GPOS,
  91   HB_OT_LAYOUT_TABLE_TYPE_NONE
  92 } hb_ot_layout_table_type_t;
  93
  94 typedef uint16_t hb_ot_layout_feature_mask_t;
  95
  96 #define HB_OT_LAYOUT_MAX_NESTING_LEVEL          100
  97
  98 #define HB_OT_LAYOUT_NO_SCRIPT_INDEX            ((unsigned int) 0xFFFF)
  99 #define HB_OT_LAYOUT_NO_FEATURE_INDEX           ((unsigned int) 0xFFFF)
 100 #define HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX     ((unsigned int) 0xFFFF)
 101 #define HB_OT_LAYOUT_TAG_DEFAULT_SCRIPT         HB_TAG ('D', 'F', 'L', 'T')
 102 #define HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE       HB_TAG ('d', 'f', 'l', 't')
 103
 104 unsigned int
 105 hb_ot_layout_table_get_script_count (hb_ot_layout_t            *layout,
 106                                      hb_ot_layout_table_type_t  table_type);
 107
 108 hb_tag_t
 109 hb_ot_layout_table_get_script_tag (hb_ot_layout_t            *layout,
 110                                    hb_ot_layout_table_type_t  table_type,
 111                                    unsigned int               script_index);
 112
 113 hb_bool_t
 114 hb_ot_layout_table_find_script (hb_ot_layout_t            *layout,
 115                                 hb_ot_layout_table_type_t  table_type,
 116                                 hb_tag_t                   script_tag,
 117                                 unsigned int              *script_index);
 118
 119 unsigned int
 120 hb_ot_layout_table_get_feature_count (hb_ot_layout_t            *layout,
 121                                       hb_ot_layout_table_type_t  table_type);
 122
 123 hb_tag_t
 124 hb_ot_layout_table_get_feature_tag (hb_ot_layout_t            *layout,
 125                                     hb_ot_layout_table_type_t  table_type,
 126                                     unsigned int               feature_index);
 127
 128 hb_bool_t
 129 hb_ot_layout_table_find_script (hb_ot_layout_t            *layout,
 130                                 hb_ot_layout_table_type_t  table_type,
 131                                 hb_tag_t                   feature_tag,
 132                                 unsigned int              *feature_index);
 133
 134 unsigned int
 135 hb_ot_layout_table_get_lookup_count (hb_ot_layout_t            *layout,
 136                                      hb_ot_layout_table_type_t  table_type);
 137
 138 unsigned int
 139 hb_ot_layout_script_get_language_count (hb_ot_layout_t            *layout,
 140                                         hb_ot_layout_table_type_t  table_type,
 141                                         unsigned int               script_index);
 142
 143 hb_tag_t
 144 hb_ot_layout_script_get_language_tag (hb_ot_layout_t            *layout,
 145                                       hb_ot_layout_table_type_t  table_type,
 146                                       unsigned int               script_index,
 147                                       unsigned int               language_index);
 148
 149 hb_bool_t
 150 hb_ot_layout_script_find_language (hb_ot_layout_t            *layout,
 151                                    hb_ot_layout_table_type_t  table_type,
 152                                    unsigned int               script_index,
 153                                    hb_tag_t                   language_tag,
 154                                    unsigned int              *language_index);
 155
 156 hb_bool_t
 157 hb_ot_layout_language_get_required_feature_index (hb_ot_layout_t            *layout,
 158                                                   hb_ot_layout_table_type_t  table_type,
 159                                                   unsigned int               script_index,
 160                                                   unsigned int               language_index,
 161                                                   unsigned int              *feature_index);
 162
 163 unsigned int
 164 hb_ot_layout_language_get_feature_count (hb_ot_layout_t            *layout,
 165                                          hb_ot_layout_table_type_t  table_type,
 166                                          unsigned int               script_index,
 167                                          unsigned int               language_index);
 168
 169 unsigned int
 170 hb_ot_layout_language_get_feature_index (hb_ot_layout_t            *layout,
 171                                          hb_ot_layout_table_type_t  table_type,
 172                                          unsigned int               script_index,
 173                                          unsigned int               language_index,
 174                                          unsigned int               num_feature);
 175
 176 hb_tag_t
 177 hb_ot_layout_language_get_feature_tag (hb_ot_layout_t            *layout,
 178                                        hb_ot_layout_table_type_t  table_type,
 179                                        unsigned int               script_index,
 180                                        unsigned int               language_index,
 181                                        unsigned int               num_feature);
 182
 183 hb_bool_t
 184 hb_ot_layout_language_find_feature (hb_ot_layout_t            *layout,
 185                                     hb_ot_layout_table_type_t  table_type,
 186                                     unsigned int               script_index,
 187                                     unsigned int               language_index,
 188                                     hb_tag_t                   feature_tag,
 189                                     unsigned int              *feature_index);
 190
 191 unsigned int
 192 hb_ot_layout_feature_get_lookup_count (hb_ot_layout_t            *layout,
 193                                        hb_ot_layout_table_type_t  table_type,
 194                                        unsigned int               feature_index);
 195
 196 unsigned int
 197 hb_ot_layout_feature_get_lookup_index (hb_ot_layout_t            *layout,
 198                                        hb_ot_layout_table_type_t  table_type,
 199                                        unsigned int               feature_index,
 200                                        unsigned int               num_lookup);
 201
 202 /*
 203  * GSUB
 204  */
 205
 206 hb_bool_t
 207 hb_ot_layout_substitute_lookup (hb_ot_layout_t              *layout,
 208                                 hb_buffer_t                 *buffer,
 209                                 unsigned int                 lookup_index,
 210                                 hb_ot_layout_feature_mask_t  mask);
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222 /*
 223 #define PANGO_OT_ALL_GLYPHS                     ((guint) 0xFFFF)
 224
 225 */
 226
 227 HB_END_DECLS();
 228
 229 #endif /* HB_OT_LAYOUT_H */