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_for_data (const char *font_data,
  42                               int         face_index);
  43
  44 void
  45 hb_ot_layout_destroy (hb_ot_layout_t *layout);
  46
  47 /* TODO sanitizing API/constructor (make_wrieable_func_t) */
  48 /* TODO get_table_func_t constructor */
  49
  50 /*
  51  * GDEF
  52  */
  53
  54 typedef enum {
  55   HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED = 0x0000,
  56   HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH   = 0x0002,
  57   HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE     = 0x0004,
  58   HB_OT_LAYOUT_GLYPH_CLASS_MARK         = 0x0008,
  59   HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT    = 0x0010
  60 } hb_ot_layout_glyph_class_t;
  61
  62 hb_bool_t
  63 hb_ot_layout_has_font_glyph_classes (hb_ot_layout_t *layout);
  64
  65 hb_ot_layout_glyph_class_t
  66 hb_ot_layout_get_glyph_class (hb_ot_layout_t *layout,
  67                               hb_glyph_t      glyph);
  68
  69 void
  70 hb_ot_layout_set_glyph_class (hb_ot_layout_t            *layout,
  71                               hb_glyph_t                 glyph,
  72                               hb_ot_layout_glyph_class_t klass);
  73
  74 void
  75 hb_ot_layout_build_glyph_classes (hb_ot_layout_t *layout,
  76                                   uint16_t        num_total_glyphs,
  77                                   hb_glyph_t     *glyphs,
  78                                   unsigned char  *klasses,
  79                                   uint16_t        count);
  80
  81 /*
  82  * GSUB/GPOS
  83  */
  84
  85 typedef enum {
  86   HB_OT_LAYOUT_TABLE_TYPE_GSUB,
  87   HB_OT_LAYOUT_TABLE_TYPE_GPOS,
  88   HB_OT_LAYOUT_TABLE_TYPE_NONE
  89 } hb_ot_layout_table_type_t;
  90
  91 #define HB_OT_LAYOUT_NO_SCRIPT_INDEX            ((unsigned int) 0xFFFF)
  92 #define HB_OT_LAYOUT_NO_FEATURE_INDEX           ((unsigned int) 0xFFFF)
  93 #define HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX     ((unsigned int) 0xFFFF)
  94 #define HB_OT_LAYOUT_TAG_DEFAULT_SCRIPT         HB_TAG ('D', 'F', 'L', 'T')
  95 #define HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE       HB_TAG ('d', 'f', 'l', 't')
  96
  97 unsigned int
  98 hb_ot_layout_get_script_count (hb_ot_layout_t            *layout,
  99                                hb_ot_layout_table_type_t  table_type);
 100
 101 hb_tag_t
 102 hb_ot_layout_get_script_tag (hb_ot_layout_t            *layout,
 103                              hb_ot_layout_table_type_t  table_type,
 104                              unsigned int               script_index);
 105
 106 hb_bool_t
 107 hb_ot_layout_find_script (hb_ot_layout_t            *layout,
 108                           hb_ot_layout_table_type_t  table_type,
 109                           hb_tag_t                   script_tag,
 110                           unsigned int              *script_index);
 111
 112 unsigned int
 113 hb_ot_layout_get_language_count (hb_ot_layout_t            *layout,
 114                                  hb_ot_layout_table_type_t  table_type,
 115                                  unsigned int               script_index);
 116
 117 hb_tag_t
 118 hb_ot_layout_get_language_tag (hb_ot_layout_t            *layout,
 119                                hb_ot_layout_table_type_t  table_type,
 120                                unsigned int               script_index,
 121                                unsigned int               language_index);
 122
 123 hb_bool_t
 124 hb_ot_layout_find_language (hb_ot_layout_t            *layout,
 125                             hb_ot_layout_table_type_t  table_type,
 126                             unsigned int               script_index,
 127                             hb_tag_t                   language_tag,
 128                             unsigned int              *language_index,
 129                             unsigned int              *required_features_index);
 130
 131
 132 /*
 133 #define PANGO_OT_ALL_GLYPHS                     ((guint) 0xFFFF)
 134
 135 */
 136
 137 HB_END_DECLS();
 138
 139 #endif /* HB_OT_LAYOUT_H */