hb-ot-layout-gdef-private.h 6.6 KB
Newer Older
B
Behdad Esfahbod 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
 * Copyright (C) 2007,2008  Red Hat, Inc.
 *
 *  This is part of HarfBuzz, an OpenType Layout engine library.
 *
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the
 * above copyright notice and the following two paragraphs appear in
 * all copies of this software.
 *
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 * Red Hat Author(s): Behdad Esfahbod
 */

27 28
#ifndef HB_OT_LAYOUT_GDEF_PRIVATE_H
#define HB_OT_LAYOUT_GDEF_PRIVATE_H
B
Behdad Esfahbod 已提交
29

B
Behdad Esfahbod 已提交
30
#include "hb-ot-layout-private.h"
B
Behdad Esfahbod 已提交
31

32
#include "hb-ot-layout-open-private.h"
B
Behdad Esfahbod 已提交
33

34

B
Behdad Esfahbod 已提交
35
#define DEFINE_INDIRECT_GLYPH_ARRAY_LOOKUP(Type, array, name) \
B
Behdad Esfahbod 已提交
36
  inline const Type& name (hb_codepoint_t glyph) { \
B
Behdad Esfahbod 已提交
37
    return this+array[(this+coverage)(glyph)]; \
38 39 40
  }


B
Behdad Esfahbod 已提交
41
struct GlyphClassDef : ClassDef {
B
Behdad Esfahbod 已提交
42 43 44 45
  static const unsigned int BaseGlyph		= 0x0001u;
  static const unsigned int LigatureGlyph	= 0x0002u;
  static const unsigned int MarkGlyph		= 0x0003u;
  static const unsigned int ComponentGlyph	= 0x0004u;
B
Behdad Esfahbod 已提交
46 47
};

48 49 50
/*
 * Attachment List Table
 */
B
Behdad Esfahbod 已提交
51

52
struct AttachPoint {
B
Behdad Esfahbod 已提交
53
  Array		pointIndex;		/* Array of contour point indices--in
54 55
					 * increasing numerical order */
};
56
ASSERT_SIZE (AttachPoint, 2);
B
Behdad Esfahbod 已提交
57

58
struct AttachList {
B
Minor  
Behdad Esfahbod 已提交
59

B
Behdad Esfahbod 已提交
60
  /* const AttachPoint& get_attach_points (hb_codepoint_t glyph); */
B
Behdad Esfahbod 已提交
61
  DEFINE_INDIRECT_GLYPH_ARRAY_LOOKUP (AttachPoint, attachPoint, get_attach_points);
B
Behdad Esfahbod 已提交
62

63
 private:
64 65
  OffsetTo<Coverage>
		coverage;		/* Offset to Coverage table -- from
B
Behdad Esfahbod 已提交
66
					 * beginning of AttachList table */
B
Behdad Esfahbod 已提交
67 68 69
  OffsetArrayOf<AttachPoint>
		attachPoint;		/* Array of AttachPoint tables
					 * in Coverage Index order */
B
Behdad Esfahbod 已提交
70
};
71
ASSERT_SIZE (AttachList, 4);
B
Behdad Esfahbod 已提交
72 73 74 75 76 77 78

/*
 * Ligature Caret Table
 */

struct CaretValueFormat1 {

B
Minor  
Behdad Esfahbod 已提交
79 80 81
  friend struct CaretValue;

  private:
B
Behdad Esfahbod 已提交
82
  inline int get_caret_value (int ppem) const {
B
Behdad Esfahbod 已提交
83
    return /* TODO garbage */ coordinate / ppem;
B
Behdad Esfahbod 已提交
84
  }
B
Behdad Esfahbod 已提交
85 86 87 88

  private:
  USHORT	caretValueFormat;	/* Format identifier--format = 1 */
  SHORT		coordinate;		/* X or Y value, in design units */
B
Behdad Esfahbod 已提交
89
};
90
ASSERT_SIZE (CaretValueFormat1, 4);
B
Behdad Esfahbod 已提交
91 92 93

struct CaretValueFormat2 {

B
Minor  
Behdad Esfahbod 已提交
94 95 96
  friend struct CaretValue;

  private:
B
Behdad Esfahbod 已提交
97
  inline int get_caret_value (int ppem) const {
B
Behdad Esfahbod 已提交
98
    return /* TODO garbage */ 0 / ppem;
B
Behdad Esfahbod 已提交
99
  }
B
Behdad Esfahbod 已提交
100 101 102 103

  private:
  USHORT	caretValueFormat;	/* Format identifier--format = 2 */
  USHORT	caretValuePoint;	/* Contour point index on glyph */
B
Behdad Esfahbod 已提交
104
};
105
ASSERT_SIZE (CaretValueFormat2, 4);
B
Behdad Esfahbod 已提交
106 107

struct CaretValueFormat3 {
B
Behdad Esfahbod 已提交
108

B
Minor  
Behdad Esfahbod 已提交
109 110 111
  friend struct CaretValue;

  private:
112
  inline const Device& get_device (void) const {
113
    if (HB_UNLIKELY (!deviceTable)) return Null(Device);
114
    return *(const Device*)((const char*)this + deviceTable);
B
Behdad Esfahbod 已提交
115 116
  }

B
Behdad Esfahbod 已提交
117
  inline int get_caret_value (int ppem) const {
118
    return /* TODO garbage */ (coordinate + get_device().get_delta (ppem)) / ppem;
B
Behdad Esfahbod 已提交
119 120 121
  }

  private:
B
Behdad Esfahbod 已提交
122 123 124 125 126 127
  USHORT	caretValueFormat;	/* Format identifier--format = 3 */
  SHORT		coordinate;		/* X or Y value, in design units */
  Offset	deviceTable;		/* Offset to Device table for X or Y
					 * value--from beginning of CaretValue
					 * table */
};
128
ASSERT_SIZE (CaretValueFormat3, 6);
B
Behdad Esfahbod 已提交
129 130 131

struct CaretValue {
  /* XXX  we need access to a load-contour-point vfunc here */
B
Minor  
Behdad Esfahbod 已提交
132
  int get_caret_value (int ppem) const {
B
Behdad Esfahbod 已提交
133 134 135 136 137 138 139 140
    switch (u.caretValueFormat) {
    case 1: return u.format1.get_caret_value(ppem);
    case 2: return u.format2.get_caret_value(ppem);
    case 3: return u.format3.get_caret_value(ppem);
    default:return 0;
    }
  }

B
Behdad Esfahbod 已提交
141
  private:
B
Behdad Esfahbod 已提交
142 143 144 145 146 147 148
  union {
  USHORT	caretValueFormat;	/* Format identifier */
  CaretValueFormat1	format1;
  CaretValueFormat2	format2;
  CaretValueFormat3	format3;
  } u;
};
149 150 151
DEFINE_NULL (CaretValue, 2);

struct LigGlyph {
B
Minor  
Behdad Esfahbod 已提交
152 153 154

  friend struct LigCaretList;

B
Behdad Esfahbod 已提交
155 156 157
  OffsetArrayOf<CaretValue>
		caret;			/* Array of CaretValue tables
					 * in increasing coordinate order */
158
};
159
ASSERT_SIZE (LigGlyph, 2);
B
Behdad Esfahbod 已提交
160

161
struct LigCaretList {
B
Minor  
Behdad Esfahbod 已提交
162 163 164 165

  friend struct GDEF;

  private:
B
Behdad Esfahbod 已提交
166
  /* const LigGlyph& get_lig_glyph (hb_codepoint_t glyph); */
B
Behdad Esfahbod 已提交
167
  DEFINE_INDIRECT_GLYPH_ARRAY_LOOKUP (LigGlyph, ligGlyph, get_lig_glyph);
168 169

  private:
170 171
  OffsetTo<Coverage>
		coverage;		/* Offset to Coverage table--from
172
					 * beginning of LigCaretList table */
B
Behdad Esfahbod 已提交
173 174 175
  OffsetArrayOf<LigGlyph>
		ligGlyph;		/* Array of LigGlyph tables
					 * in Coverage Index order */
176
};
177
ASSERT_SIZE (LigCaretList, 4);
178

179
/*
B
Behdad Esfahbod 已提交
180
 * GDEF
181
 */
B
Behdad Esfahbod 已提交
182

B
Behdad Esfahbod 已提交
183
struct GDEF {
B
Minor  
Behdad Esfahbod 已提交
184
  static const hb_tag_t Tag		= HB_TAG ('G','D','E','F');
185

B
Behdad Esfahbod 已提交
186 187 188 189 190 191
  static const hb_ot_layout_class_t UnclassifiedGlyph	= 0;
  static const hb_ot_layout_class_t BaseGlyph		= 1;
  static const hb_ot_layout_class_t LigatureGlyph	= 2;
  static const hb_ot_layout_class_t MarkGlyph		= 3;
  static const hb_ot_layout_class_t ComponentGlyph	= 4;

B
Behdad Esfahbod 已提交
192 193
  STATIC_DEFINE_GET_FOR_DATA (GDEF);
  /* XXX check version here? */
B
Behdad Esfahbod 已提交
194

B
Behdad Esfahbod 已提交
195
  inline bool has_glyph_classes () const { return glyphClassDef != 0; }
B
Behdad Esfahbod 已提交
196
  inline hb_ot_layout_class_t get_glyph_class (hb_codepoint_t glyph) const {
B
Behdad Esfahbod 已提交
197
    return glyphClassDef(this).get_class (glyph);
B
Behdad Esfahbod 已提交
198 199
  }

B
Behdad Esfahbod 已提交
200
  inline bool has_mark_attachment_types () const { return markAttachClassDef != 0; }
B
Behdad Esfahbod 已提交
201
  inline hb_ot_layout_class_t get_mark_attachment_type (hb_codepoint_t glyph) const {
B
Behdad Esfahbod 已提交
202
    return markAttachClassDef(this).get_class (glyph);
B
Behdad Esfahbod 已提交
203 204 205
  }

  /* TODO get_attach and get_lig_caret */
B
Behdad Esfahbod 已提交
206 207
  inline bool has_attach_list () const { return attachList != 0; }
  inline bool has_lig_caret_list () const { return ligCaretList != 0; }
B
Behdad Esfahbod 已提交
208

B
Behdad Esfahbod 已提交
209
  private:
B
Behdad Esfahbod 已提交
210 211
  Fixed		version;		/* Version of the GDEF table--initially
					 * 0x00010000 */
B
Behdad Esfahbod 已提交
212 213
  OffsetTo<ClassDef>
		glyphClassDef;		/* Offset to class definition table
B
Behdad Esfahbod 已提交
214
					 * for glyph type--from beginning of
215
					 * GDEF header (may be Null) */
B
Behdad Esfahbod 已提交
216 217
  OffsetTo<AttachList>
		attachList;		/* Offset to list of glyphs with
B
Behdad Esfahbod 已提交
218
					 * attachment points--from beginning
219
					 * of GDEF header (may be Null) */
B
Behdad Esfahbod 已提交
220 221
  OffsetTo<LigCaretList>
		ligCaretList;		/* Offset to list of positioning points
B
Behdad Esfahbod 已提交
222
					 * for ligature carets--from beginning
223
					 * of GDEF header (may be Null) */
B
Behdad Esfahbod 已提交
224 225
  OffsetTo<ClassDef>
		markAttachClassDef;	/* Offset to class definition table for
B
Behdad Esfahbod 已提交
226
					 * mark attachment type--from beginning
227
					 * of GDEF header (may be Null) */
B
Behdad Esfahbod 已提交
228
};
229
ASSERT_SIZE (GDEF, 12);
B
Behdad Esfahbod 已提交
230

231
#endif /* HB_OT_LAYOUT_GDEF_PRIVATE_H */