1 #ifndef __DALI_TOOLKIT_TEXT_ABSTRACTION_SCRIPT_H__
2 #define __DALI_TOOLKIT_TEXT_ABSTRACTION_SCRIPT_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/common/dali-common.h>
25 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
30 namespace TextAbstraction
34 * @brief Script is the writing system used by a language.
35 * Typically one script can be used to write different languages although one language could be written in different scrips.
39 COMMON, ///< Valid for all scripts. i.e white space or '\n'.
41 ASCII_DIGITS, ///< ASCII digits.
42 ASCII_PS, ///< ASCII punctuation and symbols.
44 C1_CONTROLS, ///< Controls of the C1 Controls and Latin-1 Supplement unicode block.
45 C1_PS, ///< Punctuation and symbols of the C1 Controls and Latin-1 Supplement unicode block.
46 C1_MATH, ///< Math symbols of the C1 Controls and Latin-1 Supplement unicode block.
48 SML_P, ///< Punctuation symbols of the Spacing Modifier Letters unicode block.
49 PHONETIC_U, ///< Uralic phonetic symbols of the Phonetic Extensions unicode block.
50 PHONETIC_SS, ///< Subscripts and superscripts of the Phonetic Extensions unicode block.
52 NUMERIC_SS, ///< Numeric subscripts and superscripts.
54 LETTER_LIKE, ///< Symbols of the Letterlike unicode block.
55 NUMBER_FORMS, ///< Number Forms unicode block.
56 FRACTIONS_NF, ///< Numeric fraction symbols of the Number Forms unicode block.
57 NON_LATIN_LED, ///< Non latin symbols within the Latin Extended D unicode block.
58 HWFW_S, ///< Non latin symbols within the Halfwidth and fullwidth unicode block.
60 CYRILLIC, ///< The Cyrillic script. Used by Russian, Bulgarian, Ukrainian, Macedonian, ...
61 GREEK, ///< The Greek script. Used by Greek.
62 LATIN, ///< The latin script. Used by many western languages and others around the world.
64 ARABIC, ///< The arabic script. Used by Arab and Urdu among others.
65 HEBREW, ///< The Hebrew script. Used by the Hebrew, Yiddish, Ladino, and Judeo-Arabic.
67 ARMENIAN, ///< The Armenian script. Used by Armenian.
68 GEORGIAN, ///< The Georgian script. Used by Georgian.
70 CJK, ///< The CJK script. Used by Chinese, Japanese, Korean and Vietnamese(old writing system).
71 HANGUL, ///< The Hangul jamo script. Used by Korean.
72 HIRAGANA, ///< The Hiragana script. Used by the Japanese.
73 KATAKANA, ///< The Katakana script. Used by the Japanese.
74 BOPOMOFO, ///< The Bopomofo script. Also called Zhuyin fuhao or Zhuyin. A phonetic notation used for the transcription of spoken Chinese.
76 BENGALI, ///< The Bengali script. Used by Bangla, Assamese, Bishnupriya Manipuri, Daphla, Garo, Hallam, Khasi, Mizo, Munda, Naga, Rian, and Santali.
77 BURMESE, ///< The Burmese script. Used by the Burmese (Myanmar) language.
78 DEVANAGARI, ///< The devanagari script. Used by Hindi, Marathi, Sindhi, Nepali and Sanskrit.
79 GUJARATI, ///< The Gujarati script. Used by Gujarati.
80 GURMUKHI, ///< The Gurmukhi script. Used by Punjabi.
81 KANNADA, ///< The Kannada script. Used by Kannada and Tulu.
82 MALAYALAM, ///< The Malayalam script. Used by Malayalam.
83 ORIYA, ///< The Oriya script. Used by Oriya (Odia), Khondi, and Santali.
84 SINHALA, ///< The Sinhala script. Used by Sinhala and Pali.
85 TAMIL, ///< The Tamil script. Used by Tamil, Badaga, and Saurashtra.
86 TELUGU, ///< The Telugu script. Used by Telugu, Gondi, and Lambadi.
88 LAO, ///< The Lao script. Used by the Lao language.
89 THAI, ///< The Thai script. Used by the Thai language
90 KHMER, ///< The Khmer script. Used by the Khmer language.
91 JAVANESE, ///< The Javanese script. Used by the Javanese language.
92 SUNDANESE, ///< The Sundanese script. Used by the Sundanese language.
94 GEEZ, ///< The Ge'ez script. Used by the Amharic, Tigrinya and other languages in Ethiopia and Eritrea.
95 OL_CHIKI, ///< The Ol Chiki script. Used by the Santali.
96 BAYBAYIN, ///< The Baybayin script. Used by the Tagalog, Bikol languages, Ilocano, Pangasinan, Visayan and other languages in Philippines.
98 EMOJI, ///< The Emoji which map to standardized Unicode characters.
100 SYMBOLS1, ///< Some symbols.
101 SYMBOLS2, ///< Some symbols.
102 SYMBOLS3, ///< Some symbols.
103 SYMBOLS4, ///< Some symbols.
104 SYMBOLS5, ///< Some symbols.
106 UNKNOWN ///< The script is unknown.
109 const char* const ScriptName[] =
111 "COMMON", ///< Valid for all scripts. i.e white space or '\n'.
113 "ASCII_DIGITS", ///< ASCII digits.
114 "ASCII_PS", ///< ASCII punctuation and symbols.
116 "C1_CONTROLS", ///< Controls of the C1 Controls and Latin-1 Supplement unicode block.
117 "C1_PS", ///< Punctuation and symbols of the C1 Controls and Latin-1 Supplement unicode block.
118 "C1_MATH", ///< Math symbols of the C1 Controls and Latin-1 Supplement unicode block.
120 "SML_P", ///< Punctuation symbols of the Spacing Modifier Letters unicode block.
121 "PHONETIC_U", ///< Uralic phonetic symbols of the Phonetic Extensions unicode block.
122 "PHONETIC_SS", ///< Subscripts and superscripts of the Phonetic Extensions unicode block.
124 "NUMERIC_SS", ///< Numeric subscripts and superscripts.
126 "LETTER_LIKE", ///< Symbols of the Letterlike unicode block.
127 "NUMBER_FORMS", ///< Number Forms unicode block.
128 "FRACTIONS_NF", ///< Numeric fraction symbols of the Number Forms unicode block.
129 "NON_LATIN_LED", ///< Non latin symbols within the Latin Extended D unicode block.
130 "HWFW_S", ///< Non latin symbols within the Halfwidth and fullwidth unicode block.
132 "CYRILLIC", ///< The Cyrillic script. Used by Russian, Bulgarian, Ukrainian, Macedonian, ...
133 "GREEK", ///< The Greek script. Used by Greek.
134 "LATIN", ///< The latin script. Used by many western languages and others around the world.
136 "ARABIC", ///< The arabic script. Used by Arab and Urdu among others.
137 "HEBREW", ///< The Hebrew script. Used by the Hebrew, Yiddish, Ladino, and Judeo-Arabic.
139 "ARMENIAN", ///< The Armenian script. Used by Armenian.
140 "GEORGIAN", ///< The Georgian script. Used by Georgian.
142 "CJK", ///< The CJK script. Used by Chinese, Japanese, Korean and Vietnamese(old writing system).
143 "HANGUL", ///< The Hangul jamo script. Used by Korean.
144 "HIRAGANA", ///< The Hiragana script. Used by the Japanese.
145 "KATAKANA", ///< The Katakana script. Used by the Japanese.
146 "BOPOMOFO", ///< The Bopomofo script. Also called Zhuyin fuhao or Zhuyin. A phonetic notation used for the transcription of spoken Chinese.
148 "BENGALI", ///< The Bengali script. Used by Bangla, Assamese, Bishnupriya Manipuri, Daphla, Garo, Hallam, Khasi, Mizo, Munda, Naga, Rian, and Santali.
149 "BURMESE", ///< The Burmese script. Used by the Burmese (Myanmar) language.
150 "DEVANAGARI", ///< The devanagari script. Used by Hindi, Marathi, Sindhi, Nepali and Sanskrit.
151 "GUJARATI", ///< The Gujarati script. Used by Gujarati.
152 "GURMUKHI", ///< The Gurmukhi script. Used by Punjabi.
153 "KANNADA", ///< The Kannada script. Used by Kannada and Tulu.
154 "MALAYALAM", ///< The Malayalam script. Used by Malayalam.
155 "ORIYA", ///< The Oriya script. Used by Oriya (Odia), Khondi, and Santali.
156 "SINHALA", ///< The Sinhala script. Used by Sinhala and Pali.
157 "TAMIL", ///< The Tamil script. Used by Tamil, Badaga, and Saurashtra.
158 "TELUGU", ///< The Telugu script. Used by Telugu, Gondi, and Lambadi.
160 "LAO", ///< The Lao script. Used by the Lao language.
161 "THAI", ///< The Thai script. Used by the Thai language
162 "KHMER", ///< The Khmer script. Used by the Khmer language.
163 "JAVANESE", ///< The Javanese script. Used by the Javanese language.
164 "SUNDANESE", ///< The Sundanese script. Used by the Sundanese language.
166 "GEEZ", ///< The Ge'ez script also known as Ethiopic. Used by the Amharic, Tigrinya and other languages in Ethiopia and Eritrea.
167 "OL_CHIKI", ///< The Ol Chiki script. Used by the Santali.
168 "BAYBAYIN", ///< The Baybayin script. Used by the Tagalog, Bikol languages, Ilocano, Pangasinan, Visayan and other languages in Philippines.
170 "EMOJI", ///< The Emoji which map to standardized Unicode characters.
172 "SYMBOLS1", ///< Some symbols.
173 "SYMBOLS2", ///< Some symbols.
174 "SYMBOLS3", ///< Some symbols.
175 "SYMBOLS4", ///< Some symbols.
176 "SYMBOLS5", ///< Some symbols.
178 "UNKNOWN" ///< The script is unknown.
182 * @brief Whether the script is a right to left script.
184 * @param[in] script The script.
186 * @return @e true if the script is right to left.
188 DALI_IMPORT_API bool IsRightToLeftScript( Script script );
191 * @brief Retrieves a character's script.
193 * @param[in] character The character.
195 * @return The chraracter's script.
197 DALI_IMPORT_API Script GetCharacterScript( Character character );
200 * @brief Whether the character is a white space.
202 * @param[in] character The character.
204 * @return @e true if the character is a white space.
206 DALI_IMPORT_API bool IsWhiteSpace( Character character );
209 * @brief Whether the character is a new paragraph character.
211 * @param[in] character The character.
213 * @return @e true if the character is a new paragraph character.
215 DALI_IMPORT_API bool IsNewParagraph( Character character );
218 * @brief Whether the character is a zero width non joiner.
220 * @param[in] character The character.
222 * @return @e true if the character is a zero width non joiner.
224 DALI_IMPORT_API bool IsZeroWidthNonJoiner( Character character );
227 * @brief Whether the character is a zero width joiner.
229 * @param[in] character The character.
231 * @return @e true if the character is a zero width joiner.
233 DALI_IMPORT_API bool IsZeroWidthJoiner( Character character );
236 * @brief Whether the character is a zero width space.
238 * @param[in] character The character.
240 * @return @e true if the character is a zero width space.
242 DALI_IMPORT_API bool IsZeroWidthSpace( Character character );
245 * @brief Whether the character is a left to right mark.
247 * @param[in] character The character.
249 * @return @e true if the character is a left to right mark.
251 DALI_IMPORT_API bool IsLeftToRightMark( Character character );
254 * @brief Whether the character is a right to left mark.
256 * @param[in] character The character.
258 * @return @e true if the character is a right to left mark.
260 DALI_IMPORT_API bool IsRightToLeftMark( Character character );
263 * @brief Whether the character is a thin space.
265 * @param[in] character The character.
267 * @return @e true if the character is a thin space.
269 DALI_IMPORT_API bool IsThinSpace( Character character );
272 * @brief Whether the character is common within all scripts.
274 * @param[in] character The character.
276 * @return @e true if the character is common within all scripts.
278 DALI_IMPORT_API bool IsCommonScript( Character character );
281 * @brief Whether the script contains ligatures that must be 'broken' for selection or cursor position.
283 * i.e The latin script has the 'ff' or 'fi' ligatures that need to be broken to position the cursor
284 * between the two characters. Equally the arabic script has the 'ﻻ' ligature that needs to be broken.
286 * @param[in] script The script.
288 * @return @e true if the script has ligatures that must be 'broken'.
290 DALI_IMPORT_API bool HasLigatureMustBreak( Script script );
291 } // namespace TextAbstraction
295 #endif // __DALI_TOOLKIT_TEXT_ABSTRACTION_SCRIPT_H__