hb-ot-shape-complex-indic-private.hh revision 9e1f80ab3eea4a74cdaa6a390e4925a479ece1c5 
1/*
2 * Copyright © 2012  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#ifndef HB_OT_SHAPE_COMPLEX_INDIC_PRIVATE_HH
28#define HB_OT_SHAPE_COMPLEX_INDIC_PRIVATE_HH
29
30#include "hb-private.hh"
31
32
33#include "hb-ot-shape-complex-private.hh"
34#include "hb-ot-shape-private.hh" /* XXX Remove */
35
36
37#define INDIC_TABLE_ELEMENT_TYPE uint16_t
38
39/* Cateories used in the OpenType spec:
40 * https://www.microsoft.com/typography/otfntdev/devanot/shaping.aspx
41 */
42/* Note: This enum is duplicated in the -machine.rl source file.
43 * Not sure how to avoid duplication. */
44enum indic_category_t {
45  OT_X = 0,
46  OT_C,
47  OT_V,
48  OT_N,
49  OT_H,
50  OT_ZWNJ,
51  OT_ZWJ,
52  OT_M,
53  OT_SM,
54  OT_VD,
55  OT_A,
56  OT_NBSP,
57  OT_DOTTEDCIRCLE, /* Not in the spec, but special in Uniscribe. /Very very/ special! */
58  OT_RS, /* Register Shifter, used in Khmer OT spec */
59  OT_Coeng,
60  OT_Repha,
61  OT_Ra, /* Not explicitly listed in the OT spec, but used in the grammar. */
62  OT_CM
63};
64
65/* Visual positions in a syllable from left to right. */
66enum indic_position_t {
67  POS_START,
68
69  POS_RA_TO_BECOME_REPH,
70  POS_PRE_M,
71  POS_PRE_C,
72
73  POS_BASE_C,
74  POS_AFTER_MAIN,
75
76  POS_ABOVE_C,
77
78  POS_BEFORE_SUB,
79  POS_BELOW_C,
80  POS_AFTER_SUB,
81
82  POS_BEFORE_POST,
83  POS_POST_C,
84  POS_AFTER_POST,
85
86  POS_FINAL_C,
87  POS_SMVD,
88
89  POS_END
90};
91
92/* Categories used in IndicSyllabicCategory.txt from UCD. */
93enum indic_syllabic_category_t {
94  INDIC_SYLLABIC_CATEGORY_OTHER			= OT_X,
95
96  INDIC_SYLLABIC_CATEGORY_AVAGRAHA		= OT_X,
97  INDIC_SYLLABIC_CATEGORY_BINDU			= OT_SM,
98  INDIC_SYLLABIC_CATEGORY_CONSONANT		= OT_C,
99  INDIC_SYLLABIC_CATEGORY_CONSONANT_DEAD	= OT_C,
100  INDIC_SYLLABIC_CATEGORY_CONSONANT_FINAL	= OT_CM,
101  INDIC_SYLLABIC_CATEGORY_CONSONANT_HEAD_LETTER	= OT_C,
102  INDIC_SYLLABIC_CATEGORY_CONSONANT_MEDIAL	= OT_CM,
103  INDIC_SYLLABIC_CATEGORY_CONSONANT_PLACEHOLDER	= OT_NBSP,
104  INDIC_SYLLABIC_CATEGORY_CONSONANT_SUBJOINED	= OT_C,
105  INDIC_SYLLABIC_CATEGORY_CONSONANT_REPHA	= OT_Repha,
106  INDIC_SYLLABIC_CATEGORY_MODIFYING_LETTER	= OT_X,
107  INDIC_SYLLABIC_CATEGORY_NUKTA			= OT_N,
108  INDIC_SYLLABIC_CATEGORY_REGISTER_SHIFTER	= OT_RS,
109  INDIC_SYLLABIC_CATEGORY_TONE_LETTER		= OT_X,
110  INDIC_SYLLABIC_CATEGORY_TONE_MARK		= OT_N,
111  INDIC_SYLLABIC_CATEGORY_VIRAMA		= OT_H,
112  INDIC_SYLLABIC_CATEGORY_VISARGA		= OT_SM,
113  INDIC_SYLLABIC_CATEGORY_VOWEL			= OT_V,
114  INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT	= OT_M,
115  INDIC_SYLLABIC_CATEGORY_VOWEL_INDEPENDENT	= OT_V
116};
117
118/* Categories used in IndicSMatraCategory.txt from UCD */
119enum indic_matra_category_t {
120  INDIC_MATRA_CATEGORY_NOT_APPLICABLE		= POS_END,
121
122  INDIC_MATRA_CATEGORY_LEFT			= POS_PRE_C,
123  INDIC_MATRA_CATEGORY_TOP			= POS_ABOVE_C,
124  INDIC_MATRA_CATEGORY_BOTTOM			= POS_BELOW_C,
125  INDIC_MATRA_CATEGORY_RIGHT			= POS_POST_C,
126
127  /* These should resolve to the position of the last part of the split sequence. */
128  INDIC_MATRA_CATEGORY_BOTTOM_AND_RIGHT		= INDIC_MATRA_CATEGORY_RIGHT,
129  INDIC_MATRA_CATEGORY_LEFT_AND_RIGHT		= INDIC_MATRA_CATEGORY_RIGHT,
130  INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM		= INDIC_MATRA_CATEGORY_BOTTOM,
131  INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM_AND_RIGHT	= INDIC_MATRA_CATEGORY_RIGHT,
132  INDIC_MATRA_CATEGORY_TOP_AND_LEFT		= INDIC_MATRA_CATEGORY_TOP,
133  INDIC_MATRA_CATEGORY_TOP_AND_LEFT_AND_RIGHT	= INDIC_MATRA_CATEGORY_RIGHT,
134  INDIC_MATRA_CATEGORY_TOP_AND_RIGHT		= INDIC_MATRA_CATEGORY_RIGHT,
135
136  INDIC_MATRA_CATEGORY_INVISIBLE		= INDIC_MATRA_CATEGORY_NOT_APPLICABLE,
137  INDIC_MATRA_CATEGORY_OVERSTRUCK		= POS_AFTER_MAIN,
138  INDIC_MATRA_CATEGORY_VISUAL_ORDER_LEFT	= POS_PRE_M
139};
140
141/* Note: We use ASSERT_STATIC_EXPR_ZERO() instead of ASSERT_STATIC_EXPR() and the comma operation
142 * because gcc fails to optimize the latter and fills the table in at runtime. */
143#define INDIC_COMBINE_CATEGORIES(S,M) \
144  (ASSERT_STATIC_EXPR_ZERO (M == INDIC_MATRA_CATEGORY_NOT_APPLICABLE || (S == INDIC_SYLLABIC_CATEGORY_VIRAMA || S == INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT)) + \
145   ASSERT_STATIC_EXPR_ZERO (S < 255 && M < 255) + \
146   ((M << 8) | S))
147
148HB_INTERNAL INDIC_TABLE_ELEMENT_TYPE
149hb_indic_get_categories (hb_codepoint_t u);
150
151#endif /* HB_OT_SHAPE_COMPLEX_INDIC_PRIVATE_HH */
152