/src/icu/source/common/uprops.h
Line | Count | Source (jump to first uncovered line) |
1 | | // © 2016 and later: Unicode, Inc. and others. |
2 | | // License & terms of use: http://www.unicode.org/copyright.html |
3 | | /* |
4 | | ******************************************************************************* |
5 | | * |
6 | | * Copyright (C) 2002-2016, International Business Machines |
7 | | * Corporation and others. All Rights Reserved. |
8 | | * |
9 | | ******************************************************************************* |
10 | | * file name: uprops.h |
11 | | * encoding: UTF-8 |
12 | | * tab size: 8 (not used) |
13 | | * indentation:4 |
14 | | * |
15 | | * created on: 2002feb24 |
16 | | * created by: Markus W. Scherer |
17 | | * |
18 | | * Constants for mostly non-core Unicode character properties |
19 | | * stored in uprops.icu. |
20 | | */ |
21 | | |
22 | | #ifndef __UPROPS_H__ |
23 | | #define __UPROPS_H__ |
24 | | |
25 | | #include "unicode/utypes.h" |
26 | | #include "unicode/uset.h" |
27 | | #include "uset_imp.h" |
28 | | #include "udataswp.h" |
29 | | |
30 | | /* indexes[] entries */ |
31 | | enum { |
32 | | UPROPS_PROPS32_INDEX, |
33 | | UPROPS_EXCEPTIONS_INDEX, |
34 | | UPROPS_EXCEPTIONS_TOP_INDEX, |
35 | | |
36 | | UPROPS_ADDITIONAL_TRIE_INDEX, |
37 | | UPROPS_ADDITIONAL_VECTORS_INDEX, |
38 | | UPROPS_ADDITIONAL_VECTORS_COLUMNS_INDEX, |
39 | | |
40 | | UPROPS_SCRIPT_EXTENSIONS_INDEX, |
41 | | |
42 | | UPROPS_RESERVED_INDEX_7, |
43 | | UPROPS_RESERVED_INDEX_8, |
44 | | |
45 | | /* size of the data file (number of 32-bit units after the header) */ |
46 | | UPROPS_DATA_TOP_INDEX, |
47 | | |
48 | | /* maximum values for code values in vector word 0 */ |
49 | | UPROPS_MAX_VALUES_INDEX=10, |
50 | | /* maximum values for code values in vector word 2 */ |
51 | | UPROPS_MAX_VALUES_2_INDEX, |
52 | | |
53 | | UPROPS_INDEX_COUNT=16 |
54 | | }; |
55 | | |
56 | | /* definitions for the main properties words */ |
57 | | enum { |
58 | | /* general category shift==0 0 (5 bits) */ |
59 | | /* reserved 5 (1 bit) */ |
60 | | UPROPS_NUMERIC_TYPE_VALUE_SHIFT=6 /* 6 (10 bits) */ |
61 | | }; |
62 | | |
63 | 0 | #define GET_CATEGORY(props) ((props)&0x1f) |
64 | 0 | #define CAT_MASK(props) U_MASK(GET_CATEGORY(props)) |
65 | | |
66 | 0 | #define GET_NUMERIC_TYPE_VALUE(props) ((props)>>UPROPS_NUMERIC_TYPE_VALUE_SHIFT) |
67 | | |
68 | | /* constants for the storage form of numeric types and values */ |
69 | | enum { |
70 | | /** No numeric value. */ |
71 | | UPROPS_NTV_NONE=0, |
72 | | /** Decimal digits: nv=0..9 */ |
73 | | UPROPS_NTV_DECIMAL_START=1, |
74 | | /** Other digits: nv=0..9 */ |
75 | | UPROPS_NTV_DIGIT_START=11, |
76 | | /** Small integers: nv=0..154 */ |
77 | | UPROPS_NTV_NUMERIC_START=21, |
78 | | /** Fractions: ((ntv>>4)-12) / ((ntv&0xf)+1) = -1..17 / 1..16 */ |
79 | | UPROPS_NTV_FRACTION_START=0xb0, |
80 | | /** |
81 | | * Large integers: |
82 | | * ((ntv>>5)-14) * 10^((ntv&0x1f)+2) = (1..9)*(10^2..10^33) |
83 | | * (only one significant decimal digit) |
84 | | */ |
85 | | UPROPS_NTV_LARGE_START=0x1e0, |
86 | | /** |
87 | | * Sexagesimal numbers: |
88 | | * ((ntv>>2)-0xbf) * 60^((ntv&3)+1) = (1..9)*(60^1..60^4) |
89 | | */ |
90 | | UPROPS_NTV_BASE60_START=0x300, |
91 | | /** |
92 | | * Fraction-20 values: |
93 | | * frac20 = ntv-0x324 = 0..0x17 -> 1|3|5|7 / 20|40|80|160|320|640 |
94 | | * numerator: num = 2*(frac20&3)+1 |
95 | | * denominator: den = 20<<(frac20>>2) |
96 | | */ |
97 | | UPROPS_NTV_FRACTION20_START=UPROPS_NTV_BASE60_START+36, // 0x300+9*4=0x324 |
98 | | /** |
99 | | * Fraction-32 values: |
100 | | * frac32 = ntv-0x34c = 0..15 -> 1|3|5|7 / 32|64|128|256 |
101 | | * numerator: num = 2*(frac32&3)+1 |
102 | | * denominator: den = 32<<(frac32>>2) |
103 | | */ |
104 | | UPROPS_NTV_FRACTION32_START=UPROPS_NTV_FRACTION20_START+24, // 0x324+6*4=0x34c |
105 | | /** No numeric value (yet). */ |
106 | | UPROPS_NTV_RESERVED_START=UPROPS_NTV_FRACTION32_START+16, // 0x34c+4*4=0x35c |
107 | | |
108 | | UPROPS_NTV_MAX_SMALL_INT=UPROPS_NTV_FRACTION_START-UPROPS_NTV_NUMERIC_START-1 |
109 | | }; |
110 | | |
111 | | #define UPROPS_NTV_GET_TYPE(ntv) \ |
112 | 0 | ((ntv==UPROPS_NTV_NONE) ? U_NT_NONE : \ |
113 | 0 | (ntv<UPROPS_NTV_DIGIT_START) ? U_NT_DECIMAL : \ |
114 | 0 | (ntv<UPROPS_NTV_NUMERIC_START) ? U_NT_DIGIT : \ |
115 | 0 | U_NT_NUMERIC) |
116 | | |
117 | | /* number of properties vector words */ |
118 | | #define UPROPS_VECTOR_WORDS 3 |
119 | | |
120 | | /* |
121 | | * Properties in vector word 0 |
122 | | * Bits |
123 | | * 31..24 DerivedAge version major/minor one nibble each |
124 | | * 23..22 3..1: Bits 21..20 & 7..0 = Script_Extensions index |
125 | | * 3: Script value from Script_Extensions |
126 | | * 2: Script=Inherited |
127 | | * 1: Script=Common |
128 | | * 0: Script=bits 21..20 & 7..0 |
129 | | * 21..20 Bits 9..8 of the UScriptCode, or index to Script_Extensions |
130 | | * 19..17 East Asian Width |
131 | | * 16.. 8 UBlockCode |
132 | | * 7.. 0 UScriptCode, or index to Script_Extensions |
133 | | */ |
134 | | |
135 | | /* derived age: one nibble each for major and minor version numbers */ |
136 | | #define UPROPS_AGE_MASK 0xff000000 |
137 | 0 | #define UPROPS_AGE_SHIFT 24 |
138 | | |
139 | | /* Script_Extensions: mask includes Script */ |
140 | 0 | #define UPROPS_SCRIPT_X_MASK 0x00f000ff |
141 | | #define UPROPS_SCRIPT_X_SHIFT 22 |
142 | | |
143 | | // The UScriptCode or Script_Extensions index is split across two bit fields. |
144 | | // (Starting with Unicode 13/ICU 66/2019 due to more varied Script_Extensions.) |
145 | | // Shift the high bits right by 12 to assemble the full value. |
146 | 0 | #define UPROPS_SCRIPT_HIGH_MASK 0x00300000 |
147 | 0 | #define UPROPS_SCRIPT_HIGH_SHIFT 12 |
148 | | #define UPROPS_MAX_SCRIPT 0x3ff |
149 | | |
150 | | #define UPROPS_EA_MASK 0x000e0000 |
151 | | #define UPROPS_EA_SHIFT 17 |
152 | | |
153 | 0 | #define UPROPS_BLOCK_MASK 0x0001ff00 |
154 | 0 | #define UPROPS_BLOCK_SHIFT 8 |
155 | | |
156 | 0 | #define UPROPS_SCRIPT_LOW_MASK 0x000000ff |
157 | | |
158 | | /* UPROPS_SCRIPT_X_WITH_COMMON must be the lowest value that involves Script_Extensions. */ |
159 | 0 | #define UPROPS_SCRIPT_X_WITH_COMMON 0x400000 |
160 | 0 | #define UPROPS_SCRIPT_X_WITH_INHERITED 0x800000 |
161 | 0 | #define UPROPS_SCRIPT_X_WITH_OTHER 0xc00000 |
162 | | |
163 | | #ifdef __cplusplus |
164 | | |
165 | | namespace { |
166 | | |
167 | 0 | inline uint32_t uprops_mergeScriptCodeOrIndex(uint32_t scriptX) { |
168 | 0 | return |
169 | 0 | ((scriptX & UPROPS_SCRIPT_HIGH_MASK) >> UPROPS_SCRIPT_HIGH_SHIFT) | |
170 | 0 | (scriptX & UPROPS_SCRIPT_LOW_MASK); |
171 | 0 | } Unexecuted instantiation: propname.cpp:(anonymous namespace)::uprops_mergeScriptCodeOrIndex(unsigned int) Unexecuted instantiation: uchar.cpp:(anonymous namespace)::uprops_mergeScriptCodeOrIndex(unsigned int) Unexecuted instantiation: uniset_props.cpp:(anonymous namespace)::uprops_mergeScriptCodeOrIndex(unsigned int) Unexecuted instantiation: uprops.cpp:(anonymous namespace)::uprops_mergeScriptCodeOrIndex(unsigned int) Unexecuted instantiation: characterproperties.cpp:(anonymous namespace)::uprops_mergeScriptCodeOrIndex(unsigned int) Unexecuted instantiation: unames.cpp:(anonymous namespace)::uprops_mergeScriptCodeOrIndex(unsigned int) |
172 | | |
173 | | } // namespace |
174 | | |
175 | | #endif // __cplusplus |
176 | | |
177 | | /* |
178 | | * Properties in vector word 1 |
179 | | * Each bit encodes one binary property. |
180 | | * The following constants represent the bit number, use 1<<UPROPS_XYZ. |
181 | | * UPROPS_BINARY_1_TOP<=32! |
182 | | * |
183 | | * Keep this list of property enums in sync with |
184 | | * propListNames[] in icu/source/tools/genprops/props2.c! |
185 | | * |
186 | | * ICU 2.6/uprops format version 3.2 stores full properties instead of "Other_". |
187 | | */ |
188 | | enum { |
189 | | UPROPS_WHITE_SPACE, |
190 | | UPROPS_DASH, |
191 | | UPROPS_HYPHEN, |
192 | | UPROPS_QUOTATION_MARK, |
193 | | UPROPS_TERMINAL_PUNCTUATION, |
194 | | UPROPS_MATH, |
195 | | UPROPS_HEX_DIGIT, |
196 | | UPROPS_ASCII_HEX_DIGIT, |
197 | | UPROPS_ALPHABETIC, |
198 | | UPROPS_IDEOGRAPHIC, |
199 | | UPROPS_DIACRITIC, |
200 | | UPROPS_EXTENDER, |
201 | | UPROPS_NONCHARACTER_CODE_POINT, |
202 | | UPROPS_GRAPHEME_EXTEND, |
203 | | UPROPS_GRAPHEME_LINK, |
204 | | UPROPS_IDS_BINARY_OPERATOR, |
205 | | UPROPS_IDS_TRINARY_OPERATOR, |
206 | | UPROPS_RADICAL, |
207 | | UPROPS_UNIFIED_IDEOGRAPH, |
208 | | UPROPS_DEFAULT_IGNORABLE_CODE_POINT, |
209 | | UPROPS_DEPRECATED, |
210 | | UPROPS_LOGICAL_ORDER_EXCEPTION, |
211 | | UPROPS_XID_START, |
212 | | UPROPS_XID_CONTINUE, |
213 | | UPROPS_ID_START, /* ICU 2.6, uprops format version 3.2 */ |
214 | | UPROPS_ID_CONTINUE, |
215 | | UPROPS_GRAPHEME_BASE, |
216 | | UPROPS_S_TERM, /* new in ICU 3.0 and Unicode 4.0.1 */ |
217 | | UPROPS_VARIATION_SELECTOR, |
218 | | UPROPS_PATTERN_SYNTAX, /* new in ICU 3.4 and Unicode 4.1 */ |
219 | | UPROPS_PATTERN_WHITE_SPACE, |
220 | | UPROPS_PREPENDED_CONCATENATION_MARK, // new in ICU 60 and Unicode 10 |
221 | | UPROPS_BINARY_1_TOP /* ==32 - full! */ |
222 | | }; |
223 | | |
224 | | /* |
225 | | * Properties in vector word 2 |
226 | | * Bits |
227 | | * 31..26 http://www.unicode.org/reports/tr51/#Emoji_Properties |
228 | | * 25..20 Line Break |
229 | | * 19..15 Sentence Break |
230 | | * 14..10 Word Break |
231 | | * 9.. 5 Grapheme Cluster Break |
232 | | * 4.. 0 Decomposition Type |
233 | | */ |
234 | | enum { |
235 | | UPROPS_2_EXTENDED_PICTOGRAPHIC=26, |
236 | | UPROPS_2_EMOJI_COMPONENT, |
237 | | UPROPS_2_EMOJI, |
238 | | UPROPS_2_EMOJI_PRESENTATION, |
239 | | UPROPS_2_EMOJI_MODIFIER, |
240 | | UPROPS_2_EMOJI_MODIFIER_BASE |
241 | | }; |
242 | | |
243 | | #define UPROPS_LB_MASK 0x03f00000 |
244 | | #define UPROPS_LB_SHIFT 20 |
245 | | |
246 | | #define UPROPS_SB_MASK 0x000f8000 |
247 | | #define UPROPS_SB_SHIFT 15 |
248 | | |
249 | | #define UPROPS_WB_MASK 0x00007c00 |
250 | | #define UPROPS_WB_SHIFT 10 |
251 | | |
252 | 0 | #define UPROPS_GCB_MASK 0x000003e0 |
253 | 0 | #define UPROPS_GCB_SHIFT 5 |
254 | | |
255 | | #define UPROPS_DT_MASK 0x0000001f |
256 | | |
257 | | /** |
258 | | * Gets the main properties value for a code point. |
259 | | * Implemented in uchar.c for uprops.cpp. |
260 | | */ |
261 | | U_CFUNC uint32_t |
262 | | u_getMainProperties(UChar32 c); |
263 | | |
264 | | /** |
265 | | * Get a properties vector word for a code point. |
266 | | * Implemented in uchar.c for uprops.cpp. |
267 | | * @return 0 if no data or illegal argument |
268 | | */ |
269 | | U_CFUNC uint32_t |
270 | | u_getUnicodeProperties(UChar32 c, int32_t column); |
271 | | |
272 | | /** |
273 | | * Get the the maximum values for some enum/int properties. |
274 | | * Use the same column numbers as for u_getUnicodeProperties(). |
275 | | * The returned value will contain maximum values stored in the same bit fields |
276 | | * as where the enum values are stored in the u_getUnicodeProperties() |
277 | | * return values for the same columns. |
278 | | * |
279 | | * Valid columns are those for properties words that contain enumerated values. |
280 | | * (ICU 2.6: columns 0 and 2) |
281 | | * For other column numbers, this function will return 0. |
282 | | * |
283 | | * @internal |
284 | | */ |
285 | | U_CFUNC int32_t |
286 | | uprv_getMaxValues(int32_t column); |
287 | | |
288 | | /** |
289 | | * Checks if c is alphabetic, or a decimal digit; implements UCHAR_POSIX_ALNUM. |
290 | | * @internal |
291 | | */ |
292 | | U_CFUNC UBool |
293 | | u_isalnumPOSIX(UChar32 c); |
294 | | |
295 | | /** |
296 | | * Checks if c is in |
297 | | * [^\p{space}\p{gc=Control}\p{gc=Surrogate}\p{gc=Unassigned}] |
298 | | * with space=\p{Whitespace} and Control=Cc. |
299 | | * Implements UCHAR_POSIX_GRAPH. |
300 | | * @internal |
301 | | */ |
302 | | U_CFUNC UBool |
303 | | u_isgraphPOSIX(UChar32 c); |
304 | | |
305 | | /** |
306 | | * Checks if c is in \p{graph}\p{blank} - \p{cntrl}. |
307 | | * Implements UCHAR_POSIX_PRINT. |
308 | | * @internal |
309 | | */ |
310 | | U_CFUNC UBool |
311 | | u_isprintPOSIX(UChar32 c); |
312 | | |
313 | | /** Some code points. @internal */ |
314 | | enum { |
315 | | TAB =0x0009, |
316 | | LF =0x000a, |
317 | | FF =0x000c, |
318 | | CR =0x000d, |
319 | | NBSP =0x00a0, |
320 | | CGJ =0x034f, |
321 | | FIGURESP=0x2007, |
322 | | HAIRSP =0x200a, |
323 | | ZWNJ =0x200c, |
324 | | ZWJ =0x200d, |
325 | | RLM =0x200f, |
326 | | NNBSP =0x202f, |
327 | | ZWNBSP =0xfeff |
328 | | }; |
329 | | |
330 | | /** |
331 | | * Get the maximum length of a (regular/1.0/extended) character name. |
332 | | * @return 0 if no character names available. |
333 | | */ |
334 | | U_CAPI int32_t U_EXPORT2 |
335 | | uprv_getMaxCharNameLength(void); |
336 | | |
337 | | /** |
338 | | * Fills set with characters that are used in Unicode character names. |
339 | | * Includes all characters that are used in regular/Unicode 1.0/extended names. |
340 | | * Just empties the set if no character names are available. |
341 | | * @param sa USetAdder to receive characters. |
342 | | */ |
343 | | U_CAPI void U_EXPORT2 |
344 | | uprv_getCharNameCharacters(const USetAdder *sa); |
345 | | |
346 | | /** |
347 | | * Constants for which data and implementation files provide which properties. |
348 | | * Used by UnicodeSet for service-specific property enumeration. |
349 | | * @internal |
350 | | */ |
351 | | enum UPropertySource { |
352 | | /** No source, not a supported property. */ |
353 | | UPROPS_SRC_NONE, |
354 | | /** From uchar.c/uprops.icu main trie */ |
355 | | UPROPS_SRC_CHAR, |
356 | | /** From uchar.c/uprops.icu properties vectors trie */ |
357 | | UPROPS_SRC_PROPSVEC, |
358 | | /** From unames.c/unames.icu */ |
359 | | UPROPS_SRC_NAMES, |
360 | | /** From ucase.c/ucase.icu */ |
361 | | UPROPS_SRC_CASE, |
362 | | /** From ubidi_props.c/ubidi.icu */ |
363 | | UPROPS_SRC_BIDI, |
364 | | /** From uchar.c/uprops.icu main trie as well as properties vectors trie */ |
365 | | UPROPS_SRC_CHAR_AND_PROPSVEC, |
366 | | /** From ucase.c/ucase.icu as well as unorm.cpp/unorm.icu */ |
367 | | UPROPS_SRC_CASE_AND_NORM, |
368 | | /** From normalizer2impl.cpp/nfc.nrm */ |
369 | | UPROPS_SRC_NFC, |
370 | | /** From normalizer2impl.cpp/nfkc.nrm */ |
371 | | UPROPS_SRC_NFKC, |
372 | | /** From normalizer2impl.cpp/nfkc_cf.nrm */ |
373 | | UPROPS_SRC_NFKC_CF, |
374 | | /** From normalizer2impl.cpp/nfc.nrm canonical iterator data */ |
375 | | UPROPS_SRC_NFC_CANON_ITER, |
376 | | // Text layout properties. |
377 | | UPROPS_SRC_INPC, |
378 | | UPROPS_SRC_INSC, |
379 | | UPROPS_SRC_VO, |
380 | | /** One more than the highest UPropertySource (UPROPS_SRC_) constant. */ |
381 | | UPROPS_SRC_COUNT |
382 | | }; |
383 | | typedef enum UPropertySource UPropertySource; |
384 | | |
385 | | /** |
386 | | * @see UPropertySource |
387 | | * @internal |
388 | | */ |
389 | | U_CFUNC UPropertySource U_EXPORT2 |
390 | | uprops_getSource(UProperty which); |
391 | | |
392 | | /** |
393 | | * Enumerate uprops.icu's main data trie and add the |
394 | | * start of each range of same properties to the set. |
395 | | * @internal |
396 | | */ |
397 | | U_CFUNC void U_EXPORT2 |
398 | | uchar_addPropertyStarts(const USetAdder *sa, UErrorCode *pErrorCode); |
399 | | |
400 | | /** |
401 | | * Enumerate uprops.icu's properties vectors trie and add the |
402 | | * start of each range of same properties to the set. |
403 | | * @internal |
404 | | */ |
405 | | U_CFUNC void U_EXPORT2 |
406 | | upropsvec_addPropertyStarts(const USetAdder *sa, UErrorCode *pErrorCode); |
407 | | |
408 | | U_CFUNC void U_EXPORT2 |
409 | | uprops_addPropertyStarts(UPropertySource src, const USetAdder *sa, UErrorCode *pErrorCode); |
410 | | |
411 | | /** |
412 | | * Return a set of characters for property enumeration. |
413 | | * For each two consecutive characters (start, limit) in the set, |
414 | | * all of the properties for start..limit-1 are all the same. |
415 | | * |
416 | | * @param sa USetAdder to receive result. Existing contents are lost. |
417 | | * @internal |
418 | | */ |
419 | | /*U_CFUNC void U_EXPORT2 |
420 | | uprv_getInclusions(const USetAdder *sa, UErrorCode *pErrorCode); |
421 | | */ |
422 | | |
423 | | /** |
424 | | * Swap the ICU Unicode character names file. See uchar.c. |
425 | | * @internal |
426 | | */ |
427 | | U_CAPI int32_t U_EXPORT2 |
428 | | uchar_swapNames(const UDataSwapper *ds, |
429 | | const void *inData, int32_t length, void *outData, |
430 | | UErrorCode *pErrorCode); |
431 | | |
432 | | #ifdef __cplusplus |
433 | | |
434 | | U_NAMESPACE_BEGIN |
435 | | |
436 | | class UnicodeSet; |
437 | | |
438 | | class CharacterProperties { |
439 | | public: |
440 | | CharacterProperties() = delete; |
441 | | static const UnicodeSet *getInclusionsForProperty(UProperty prop, UErrorCode &errorCode); |
442 | | }; |
443 | | |
444 | | // implemented in uniset_props.cpp |
445 | | U_CFUNC UnicodeSet * |
446 | | uniset_getUnicode32Instance(UErrorCode &errorCode); |
447 | | |
448 | | U_NAMESPACE_END |
449 | | |
450 | | #endif |
451 | | |
452 | | #endif |