1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25 // This file is available under and governed by the GNU General Public
26 // License version 2 only, as published by the Free Software Foundation.
27 // However, the following notice accompanied the original version of this
28 // file:
29 //
30 /*
31 * Copyright © 2012 Google, Inc.
32 *
33 * This is part of HarfBuzz, a text shaping library.
34 *
35 * Permission is hereby granted, without written agreement and without
36 * license or royalty fees, to use, copy, modify, and distribute this
37 * software and its documentation for any purpose, provided that the
38 * above copyright notice and the following two paragraphs appear in
39 * all copies of this software.
40 *
41 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
42 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
43 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
44 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
45 * DAMAGE.
46 *
47 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
48 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
49 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
50 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
51 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
52 *
53 * Google Author(s): Behdad Esfahbod
54 */
55
56 #ifndef HB_OT_SHAPE_COMPLEX_INDIC_PRIVATE_HH
57 #define HB_OT_SHAPE_COMPLEX_INDIC_PRIVATE_HH
58
59 #include "hb-private.hh"
60
61
62 #include "hb-ot-shape-complex-private.hh"
63 #include "hb-ot-shape-private.hh" /* XXX Remove */
64
65
66 #define INDIC_TABLE_ELEMENT_TYPE uint16_t
67
68 /* Cateories used in the OpenType spec:
69 * https://www.microsoft.com/typography/otfntdev/devanot/shaping.aspx
70 */
71 /* Note: This enum is duplicated in the -machine.rl source file.
72 * Not sure how to avoid duplication. */
73 enum indic_category_t {
74 OT_X = 0,
75 OT_C = 1,
76 OT_V = 2,
77 OT_N = 3,
78 OT_H = 4,
79 OT_ZWNJ = 5,
80 OT_ZWJ = 6,
81 OT_M = 7,
82 OT_SM = 8,
83 OT_VD = 9,
84 OT_A = 10,
85 OT_PLACEHOLDER = 11,
86 OT_DOTTEDCIRCLE = 12,
87 OT_RS = 13, /* Register Shifter, used in Khmer OT spec. */
88 OT_Coeng = 14, /* Khmer-style Virama. */
89 OT_Repha = 15, /* Atomically-encoded logical or visual repha. */
90 OT_Ra = 16,
91 OT_CM = 17, /* Consonant-Medial. */
92 OT_Symbol = 18, /* Avagraha, etc that take marks (SM,A,VD). */
93 OT_CM2 = 31 /* Consonant-Medial, second slot. */
94 };
95
96 #define MEDIAL_FLAGS (FLAG (OT_CM) | FLAG (OT_CM2))
97
98 /* Note:
99 *
100 * We treat Vowels and placeholders as if they were consonants. This is safe because Vowels
101 * cannot happen in a consonant syllable. The plus side however is, we can call the
102 * consonant syllable logic from the vowel syllable function and get it all right! */
103 #define CONSONANT_FLAGS (FLAG (OT_C) | FLAG (OT_Ra) | MEDIAL_FLAGS | FLAG (OT_V) | FLAG (OT_PLACEHOLDER) | FLAG (OT_DOTTEDCIRCLE))
104 #define JOINER_FLAGS (FLAG (OT_ZWJ) | FLAG (OT_ZWNJ))
105 #define HALANT_OR_COENG_FLAGS (FLAG (OT_H) | FLAG (OT_Coeng))
106
107
108 /* Visual positions in a syllable from left to right. */
109 enum indic_position_t {
110 POS_START,
111
112 POS_RA_TO_BECOME_REPH,
113 POS_PRE_M,
114 POS_PRE_C,
115
116 POS_BASE_C,
117 POS_AFTER_MAIN,
118
119 POS_ABOVE_C,
120
121 POS_BEFORE_SUB,
122 POS_BELOW_C,
123 POS_AFTER_SUB,
124
125 POS_BEFORE_POST,
126 POS_POST_C,
127 POS_AFTER_POST,
128
129 POS_FINAL_C,
130 POS_SMVD,
131
132 POS_END
133 };
134
135 /* Categories used in IndicSyllabicCategory.txt from UCD. */
136 enum indic_syllabic_category_t {
137 INDIC_SYLLABIC_CATEGORY_OTHER = OT_X,
138
139 INDIC_SYLLABIC_CATEGORY_AVAGRAHA = OT_Symbol,
140 INDIC_SYLLABIC_CATEGORY_BINDU = OT_SM,
141 INDIC_SYLLABIC_CATEGORY_BRAHMI_JOINING_NUMBER = OT_PLACEHOLDER, /* TODO */
142 INDIC_SYLLABIC_CATEGORY_CANTILLATION_MARK = OT_A,
143 INDIC_SYLLABIC_CATEGORY_CONSONANT = OT_C,
144 INDIC_SYLLABIC_CATEGORY_CONSONANT_DEAD = OT_C,
145 INDIC_SYLLABIC_CATEGORY_CONSONANT_FINAL = OT_CM,
146 INDIC_SYLLABIC_CATEGORY_CONSONANT_HEAD_LETTER = OT_C,
147 INDIC_SYLLABIC_CATEGORY_CONSONANT_MEDIAL = OT_CM,
148 INDIC_SYLLABIC_CATEGORY_CONSONANT_PLACEHOLDER = OT_PLACEHOLDER,
149 INDIC_SYLLABIC_CATEGORY_CONSONANT_PRECEDING_REPHA = OT_Repha,
150 INDIC_SYLLABIC_CATEGORY_CONSONANT_SUBJOINED = OT_CM,
151 INDIC_SYLLABIC_CATEGORY_CONSONANT_SUCCEEDING_REPHA = OT_N,
152 INDIC_SYLLABIC_CATEGORY_GEMINATION_MARK = OT_SM,
153 INDIC_SYLLABIC_CATEGORY_INVISIBLE_STACKER = OT_H, /* TODO */
154 INDIC_SYLLABIC_CATEGORY_JOINER = OT_ZWJ,
155 INDIC_SYLLABIC_CATEGORY_MODIFYING_LETTER = OT_X,
156 INDIC_SYLLABIC_CATEGORY_NON_JOINER = OT_ZWNJ,
157 INDIC_SYLLABIC_CATEGORY_NUKTA = OT_N,
158 INDIC_SYLLABIC_CATEGORY_NUMBER = OT_PLACEHOLDER,
159 INDIC_SYLLABIC_CATEGORY_NUMBER_JOINER = OT_PLACEHOLDER, /* TODO */
160 INDIC_SYLLABIC_CATEGORY_PURE_KILLER = OT_H, /* TODO */
161 INDIC_SYLLABIC_CATEGORY_REGISTER_SHIFTER = OT_RS,
162 INDIC_SYLLABIC_CATEGORY_TONE_LETTER = OT_X,
163 INDIC_SYLLABIC_CATEGORY_TONE_MARK = OT_N,
164 INDIC_SYLLABIC_CATEGORY_VIRAMA = OT_H,
165 INDIC_SYLLABIC_CATEGORY_VISARGA = OT_SM,
166 INDIC_SYLLABIC_CATEGORY_VOWEL = OT_V,
167 INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT = OT_M,
168 INDIC_SYLLABIC_CATEGORY_VOWEL_INDEPENDENT = OT_V
169 };
170
171 /* Categories used in IndicSMatraCategory.txt from UCD */
172 enum indic_matra_category_t {
173 INDIC_MATRA_CATEGORY_NOT_APPLICABLE = POS_END,
174
175 INDIC_MATRA_CATEGORY_LEFT = POS_PRE_C,
176 INDIC_MATRA_CATEGORY_TOP = POS_ABOVE_C,
177 INDIC_MATRA_CATEGORY_BOTTOM = POS_BELOW_C,
178 INDIC_MATRA_CATEGORY_RIGHT = POS_POST_C,
179
180 /* These should resolve to the position of the last part of the split sequence. */
181 INDIC_MATRA_CATEGORY_BOTTOM_AND_RIGHT = INDIC_MATRA_CATEGORY_RIGHT,
182 INDIC_MATRA_CATEGORY_LEFT_AND_RIGHT = INDIC_MATRA_CATEGORY_RIGHT,
183 INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM = INDIC_MATRA_CATEGORY_BOTTOM,
184 INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM_AND_RIGHT = INDIC_MATRA_CATEGORY_RIGHT,
185 INDIC_MATRA_CATEGORY_TOP_AND_LEFT = INDIC_MATRA_CATEGORY_TOP,
186 INDIC_MATRA_CATEGORY_TOP_AND_LEFT_AND_RIGHT = INDIC_MATRA_CATEGORY_RIGHT,
187 INDIC_MATRA_CATEGORY_TOP_AND_RIGHT = INDIC_MATRA_CATEGORY_RIGHT,
188
189 INDIC_MATRA_CATEGORY_OVERSTRUCK = POS_AFTER_MAIN,
190 INDIC_MATRA_CATEGORY_VISUAL_ORDER_LEFT = POS_PRE_M
191 };
192
193 #define INDIC_COMBINE_CATEGORIES(S,M) \
194 (ASSERT_STATIC_EXPR_ZERO (M == INDIC_MATRA_CATEGORY_NOT_APPLICABLE || \
195 ( \
196 S == INDIC_SYLLABIC_CATEGORY_CONSONANT_MEDIAL || \
197 S == INDIC_SYLLABIC_CATEGORY_GEMINATION_MARK || \
198 S == INDIC_SYLLABIC_CATEGORY_REGISTER_SHIFTER || \
199 S == INDIC_SYLLABIC_CATEGORY_CONSONANT_SUCCEEDING_REPHA || \
200 S == INDIC_SYLLABIC_CATEGORY_VIRAMA || \
201 S == INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT || \
202 false)) + \
203 ASSERT_STATIC_EXPR_ZERO (S < 255 && M < 255) + \
204 ((M << 8) | S))
205
206 HB_INTERNAL INDIC_TABLE_ELEMENT_TYPE
207 hb_indic_get_categories (hb_codepoint_t u);
208
209 #endif /* HB_OT_SHAPE_COMPLEX_INDIC_PRIVATE_HH */