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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
|
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*
* Copyright (C) 2002-2016, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
* file name: uprops.h
* encoding: UTF-8
* tab size: 8 (not used)
* indentation:4
*
* created on: 2002feb24
* created by: Markus W. Scherer
*
* Constants for mostly non-core Unicode character properties
* stored in uprops.icu.
*/
#ifndef __UPROPS_H__
#define __UPROPS_H__
#include "unicode/utypes.h"
#include "unicode/uset.h"
#include "uset_imp.h"
#include "udataswp.h"
/* indexes[] entries */
enum {
UPROPS_PROPS32_INDEX,
UPROPS_EXCEPTIONS_INDEX,
UPROPS_EXCEPTIONS_TOP_INDEX,
UPROPS_ADDITIONAL_TRIE_INDEX,
UPROPS_ADDITIONAL_VECTORS_INDEX,
UPROPS_ADDITIONAL_VECTORS_COLUMNS_INDEX,
UPROPS_SCRIPT_EXTENSIONS_INDEX,
UPROPS_BLOCK_TRIE_INDEX,
UPROPS_RESERVED_INDEX_8,
/** size of the data file (number of 32-bit units after the header) */
UPROPS_DATA_TOP_INDEX,
/** maximum values for code values in vector word 0 */
UPROPS_MAX_VALUES_INDEX=10,
/** maximum values for code values in vector word 2 */
UPROPS_MAX_VALUES_2_INDEX,
/** maximum values for other code values */
UPROPS_MAX_VALUES_OTHER_INDEX,
UPROPS_INDEX_COUNT=16
};
/* definitions for the main properties words */
enum {
/* general category shift==0 0 (5 bits) */
/* reserved 5 (1 bit) */
UPROPS_NUMERIC_TYPE_VALUE_SHIFT=6 /* 6 (10 bits) */
};
#define GET_CATEGORY(props) ((props)&0x1f)
#define CAT_MASK(props) U_MASK(GET_CATEGORY(props))
#define GET_NUMERIC_TYPE_VALUE(props) ((props)>>UPROPS_NUMERIC_TYPE_VALUE_SHIFT)
/* constants for the storage form of numeric types and values */
enum {
/** No numeric value. */
UPROPS_NTV_NONE=0,
/** Decimal digits: nv=0..9 */
UPROPS_NTV_DECIMAL_START=1,
/** Other digits: nv=0..9 */
UPROPS_NTV_DIGIT_START=11,
/** Small integers: nv=0..154 */
UPROPS_NTV_NUMERIC_START=21,
/** Fractions: ((ntv>>4)-12) / ((ntv&0xf)+1) = -1..17 / 1..16 */
UPROPS_NTV_FRACTION_START=0xb0,
/**
* Large integers:
* ((ntv>>5)-14) * 10^((ntv&0x1f)+2) = (1..9)*(10^2..10^33)
* (only one significant decimal digit)
*/
UPROPS_NTV_LARGE_START=0x1e0,
/**
* Sexagesimal numbers:
* ((ntv>>2)-0xbf) * 60^((ntv&3)+1) = (1..9)*(60^1..60^4)
*/
UPROPS_NTV_BASE60_START=0x300,
/**
* Fraction-20 values:
* frac20 = ntv-0x324 = 0..0x17 -> 1|3|5|7 / 20|40|80|160|320|640
* numerator: num = 2*(frac20&3)+1
* denominator: den = 20<<(frac20>>2)
*/
UPROPS_NTV_FRACTION20_START=UPROPS_NTV_BASE60_START+36, // 0x300+9*4=0x324
/**
* Fraction-32 values:
* frac32 = ntv-0x34c = 0..15 -> 1|3|5|7 / 32|64|128|256
* numerator: num = 2*(frac32&3)+1
* denominator: den = 32<<(frac32>>2)
*/
UPROPS_NTV_FRACTION32_START=UPROPS_NTV_FRACTION20_START+24, // 0x324+6*4=0x34c
/** No numeric value (yet). */
UPROPS_NTV_RESERVED_START=UPROPS_NTV_FRACTION32_START+16, // 0x34c+4*4=0x35c
UPROPS_NTV_MAX_SMALL_INT=UPROPS_NTV_FRACTION_START-UPROPS_NTV_NUMERIC_START-1
};
#define UPROPS_NTV_GET_TYPE(ntv) \
((ntv==UPROPS_NTV_NONE) ? U_NT_NONE : \
(ntv<UPROPS_NTV_DIGIT_START) ? U_NT_DECIMAL : \
(ntv<UPROPS_NTV_NUMERIC_START) ? U_NT_DIGIT : \
U_NT_NUMERIC)
/* number of properties vector words */
#define UPROPS_VECTOR_WORDS 3
#ifdef __cplusplus
namespace {
// Properties in vector word 0
// Bits
// 31..26 Age major version (major=0..63)
// 25..24 Age minor version (minor=0..3)
// 23..17 reserved
// 16..15 Indic Conjunct Break
// 14..12 East Asian Width
// 11..10 3..1: Bits 9..0 = Script_Extensions index
// 3: Script value from Script_Extensions
// 2: Script=Inherited
// 1: Script=Common
// 0: Script=bits 9..0
// 9.. 0 UScriptCode, or index to Script_Extensions
// *Note*: If we need more than the available bits for new properties,
// then we could move the Age property out of the properties vectors.
// For example, we could store the Age property in its own trie.
// In a small, 8-bit-value-width CodePointTrie, it would be larger than
// the amount of data that we would save in the properties vectors and their trie,
// but the size increase would be a small percentage of the total uprops.icu size.
// It would certainly be a much smaller increase than widening the properties vectors.
// The savings in the properties vectors+trie from pulling out the Age property
// are partly from mediocre correlation between Age and other property values.
// (Adding new characters to existing scripts tends to split property vectors where
// new characters are similar to old ones.)
// See https://github.com/unicode-org/icu/pull/3025 for details.
inline constexpr uint32_t UPROPS_AGE_MASK = 0xff000000;
inline constexpr int32_t UPROPS_AGE_SHIFT = 24;
inline constexpr uint8_t UPROPS_AGE_MAJOR_MAX = 63;
inline constexpr uint8_t UPROPS_AGE_MINOR_MAX = 3;
inline constexpr uint32_t UPROPS_EA_MASK = 0x00007000;
inline constexpr int32_t UPROPS_EA_SHIFT = 12;
inline constexpr uint32_t UPROPS_INCB_MASK = 0x00018000;
inline constexpr int32_t UPROPS_INCB_SHIFT = 15;
/** Script_Extensions: mask includes Script */
inline constexpr uint32_t UPROPS_SCRIPT_X_MASK = 0x00000fff;
// UPROPS_SCRIPT_X_WITH_COMMON must be the lowest value that involves Script_Extensions.
inline constexpr uint32_t UPROPS_SCRIPT_X_WITH_OTHER = 0xc00;
inline constexpr uint32_t UPROPS_SCRIPT_X_WITH_INHERITED = 0x800;
inline constexpr uint32_t UPROPS_SCRIPT_X_WITH_COMMON = 0x400;
inline constexpr int32_t UPROPS_MAX_SCRIPT = 0x3ff;
/*
* Properties in vector word 1
* Each bit encodes one binary property.
* The following constants represent the bit number, use 1<<UPROPS_XYZ.
* UPROPS_BINARY_1_TOP<=32!
*
* Keep this list of property enums in sync with
* propListNames[] in icu/source/tools/genprops/props2.c!
*
* ICU 2.6/uprops format version 3.2 stores full properties instead of "Other_".
*/
enum {
UPROPS_WHITE_SPACE,
UPROPS_DASH,
UPROPS_HYPHEN,
UPROPS_QUOTATION_MARK,
UPROPS_TERMINAL_PUNCTUATION,
UPROPS_MATH,
UPROPS_HEX_DIGIT,
UPROPS_ASCII_HEX_DIGIT,
UPROPS_ALPHABETIC,
UPROPS_IDEOGRAPHIC,
UPROPS_DIACRITIC,
UPROPS_EXTENDER,
UPROPS_NONCHARACTER_CODE_POINT,
UPROPS_GRAPHEME_EXTEND,
UPROPS_GRAPHEME_LINK,
UPROPS_IDS_BINARY_OPERATOR,
UPROPS_IDS_TRINARY_OPERATOR,
UPROPS_RADICAL,
UPROPS_UNIFIED_IDEOGRAPH,
UPROPS_DEFAULT_IGNORABLE_CODE_POINT,
UPROPS_DEPRECATED,
UPROPS_LOGICAL_ORDER_EXCEPTION,
UPROPS_XID_START,
UPROPS_XID_CONTINUE,
UPROPS_ID_START, /* ICU 2.6, uprops format version 3.2 */
UPROPS_ID_CONTINUE,
UPROPS_GRAPHEME_BASE,
UPROPS_S_TERM, /* new in ICU 3.0 and Unicode 4.0.1 */
UPROPS_VARIATION_SELECTOR,
UPROPS_PATTERN_SYNTAX, /* new in ICU 3.4 and Unicode 4.1 */
UPROPS_PATTERN_WHITE_SPACE,
UPROPS_PREPENDED_CONCATENATION_MARK, // new in ICU 60 and Unicode 10
UPROPS_BINARY_1_TOP /* ==32 - full! */
};
/*
* Properties in vector word 2
* Bits
* 31..26 ICU 75: Identifier_Type bit set
* ICU 70..74: unused
* ICU 57..69: emoji properties; moved to uemoji.icu in ICU 70
* 25..20 Line Break
* 19..15 Sentence Break
* 14..10 Word Break
* 9.. 5 Grapheme Cluster Break
* 4.. 0 Decomposition Type
*/
// https://www.unicode.org/reports/tr39/#Identifier_Status_and_Type
// The Identifier_Type maps each code point to a *set* of one or more values.
// Some can be combined with others, some can only occur alone.
// Exclusion & Limited_Use are combinable bits, but cannot occur together.
// We use this forbidden combination for enumerated values.
// We use 6 bits for all possible combinations.
// If more combinable values are added, then we need to use more bits.
//
// We do not store separate data for Identifier_Status:
// We can derive that from the encoded Identifier_Type via a simple range check.
inline constexpr uint32_t UPROPS_2_ID_TYPE_MASK = 0xfc000000;
inline constexpr int32_t UPROPS_2_ID_TYPE_SHIFT = 26;
enum {
// A high bit for use in idTypeToEncoded[] but not used in the data
UPROPS_ID_TYPE_BIT = 0x80,
// Combinable bits
UPROPS_ID_TYPE_EXCLUSION = 0x20,
UPROPS_ID_TYPE_LIMITED_USE = 0x10,
UPROPS_ID_TYPE_UNCOMMON_USE = 8,
UPROPS_ID_TYPE_TECHNICAL = 4,
UPROPS_ID_TYPE_OBSOLETE = 2,
UPROPS_ID_TYPE_NOT_XID = 1,
// Exclusive values
UPROPS_ID_TYPE_NOT_CHARACTER = 0,
// Forbidden bit combination used for enumerating other exclusive values
UPROPS_ID_TYPE_FORBIDDEN = UPROPS_ID_TYPE_EXCLUSION | UPROPS_ID_TYPE_LIMITED_USE, // 0x30
UPROPS_ID_TYPE_DEPRECATED = UPROPS_ID_TYPE_FORBIDDEN, // 0x30
UPROPS_ID_TYPE_DEFAULT_IGNORABLE, // 0x31
UPROPS_ID_TYPE_NOT_NFKC, // 0x32
UPROPS_ID_TYPE_ALLOWED_MIN = UPROPS_ID_TYPE_FORBIDDEN + 0xc, // 0x3c
UPROPS_ID_TYPE_INCLUSION = UPROPS_ID_TYPE_FORBIDDEN + 0xe, // 0x3e
UPROPS_ID_TYPE_RECOMMENDED = UPROPS_ID_TYPE_FORBIDDEN + 0xf, // 0x3f
};
/**
* Maps UIdentifierType to encoded bits.
* When UPROPS_ID_TYPE_BIT is set, then use "&" to test whether the value bit is set.
* When UPROPS_ID_TYPE_BIT is not set, then compare ("==") the array value with the data value.
*/
inline constexpr uint8_t uprops_idTypeToEncoded[] = {
UPROPS_ID_TYPE_NOT_CHARACTER,
UPROPS_ID_TYPE_DEPRECATED,
UPROPS_ID_TYPE_DEFAULT_IGNORABLE,
UPROPS_ID_TYPE_NOT_NFKC,
UPROPS_ID_TYPE_BIT | UPROPS_ID_TYPE_NOT_XID,
UPROPS_ID_TYPE_BIT | UPROPS_ID_TYPE_EXCLUSION,
UPROPS_ID_TYPE_BIT | UPROPS_ID_TYPE_OBSOLETE,
UPROPS_ID_TYPE_BIT | UPROPS_ID_TYPE_TECHNICAL,
UPROPS_ID_TYPE_BIT | UPROPS_ID_TYPE_UNCOMMON_USE,
UPROPS_ID_TYPE_BIT | UPROPS_ID_TYPE_LIMITED_USE,
UPROPS_ID_TYPE_INCLUSION,
UPROPS_ID_TYPE_RECOMMENDED
};
} // namespace
#endif // __cplusplus
#define UPROPS_LB_MASK 0x03f00000
#define UPROPS_LB_SHIFT 20
#define UPROPS_SB_MASK 0x000f8000
#define UPROPS_SB_SHIFT 15
#define UPROPS_WB_MASK 0x00007c00
#define UPROPS_WB_SHIFT 10
#define UPROPS_GCB_MASK 0x000003e0
#define UPROPS_GCB_SHIFT 5
#define UPROPS_DT_MASK 0x0000001f
#ifdef __cplusplus
namespace {
// Bits 9..0 in UPROPS_MAX_VALUES_OTHER_INDEX
inline constexpr uint32_t UPROPS_MAX_BLOCK = 0x3ff;
} // namespace
#endif // __cplusplus
/**
* Gets the main properties value for a code point.
* Implemented in uchar.c for uprops.cpp.
*/
U_CFUNC uint32_t
u_getMainProperties(UChar32 c);
/**
* Get a properties vector word for a code point.
* Implemented in uchar.c for uprops.cpp.
* @return 0 if no data or illegal argument
*/
U_CFUNC uint32_t
u_getUnicodeProperties(UChar32 c, int32_t column);
/**
* Get the the maximum values for some enum/int properties.
* Use the same column numbers as for u_getUnicodeProperties().
* The returned value will contain maximum values stored in the same bit fields
* as where the enum values are stored in the u_getUnicodeProperties()
* return values for the same columns.
*
* Valid columns are those for properties words that contain enumerated values.
* (ICU 2.6: columns 0 and 2)
* For other column numbers, this function will return 0.
*
* @internal
*/
U_CFUNC int32_t
uprv_getMaxValues(int32_t column);
/**
* Checks if c is alphabetic, or a decimal digit; implements UCHAR_POSIX_ALNUM.
* @internal
*/
U_CFUNC UBool
u_isalnumPOSIX(UChar32 c);
/**
* Checks if c is in
* [^\p{space}\p{gc=Control}\p{gc=Surrogate}\p{gc=Unassigned}]
* with space=\p{Whitespace} and Control=Cc.
* Implements UCHAR_POSIX_GRAPH.
* @internal
*/
U_CFUNC UBool
u_isgraphPOSIX(UChar32 c);
/**
* Checks if c is in \p{graph}\p{blank} - \p{cntrl}.
* Implements UCHAR_POSIX_PRINT.
* @internal
*/
U_CFUNC UBool
u_isprintPOSIX(UChar32 c);
/** Some code points. @internal */
enum {
TAB =0x0009,
LF =0x000a,
FF =0x000c,
CR =0x000d,
NBSP =0x00a0,
CGJ =0x034f,
FIGURESP=0x2007,
HAIRSP =0x200a,
ZWNJ =0x200c,
ZWJ =0x200d,
RLM =0x200f,
NNBSP =0x202f,
ZWNBSP =0xfeff
};
// TODO: Move these two functions into a different header file (new unames.h?) so that uprops.h
// need not be C-compatible any more.
/**
* Get the maximum length of a (regular/1.0/extended) character name.
* @return 0 if no character names available.
*/
U_CAPI int32_t U_EXPORT2
uprv_getMaxCharNameLength(void);
/**
* Fills set with characters that are used in Unicode character names.
* Includes all characters that are used in regular/Unicode 1.0/extended names.
* Just empties the set if no character names are available.
* @param sa USetAdder to receive characters.
*/
U_CAPI void U_EXPORT2
uprv_getCharNameCharacters(const USetAdder *sa);
/**
* Constants for which data and implementation files provide which properties.
* Used by UnicodeSet for service-specific property enumeration.
* @internal
*/
enum UPropertySource {
/** No source, not a supported property. */
UPROPS_SRC_NONE,
/** From uchar.c/uprops.icu main trie */
UPROPS_SRC_CHAR,
/** From uchar.c/uprops.icu properties vectors trie */
UPROPS_SRC_PROPSVEC,
/** From unames.c/unames.icu */
UPROPS_SRC_NAMES,
/** From ucase.c/ucase.icu */
UPROPS_SRC_CASE,
/** From ubidi_props.c/ubidi.icu */
UPROPS_SRC_BIDI,
/** From uchar.c/uprops.icu main trie as well as properties vectors trie */
UPROPS_SRC_CHAR_AND_PROPSVEC,
/** From ucase.c/ucase.icu as well as unorm.cpp/unorm.icu */
UPROPS_SRC_CASE_AND_NORM,
/** From normalizer2impl.cpp/nfc.nrm */
UPROPS_SRC_NFC,
/** From normalizer2impl.cpp/nfkc.nrm */
UPROPS_SRC_NFKC,
/** From normalizer2impl.cpp/nfkc_cf.nrm */
UPROPS_SRC_NFKC_CF,
/** From normalizer2impl.cpp/nfc.nrm canonical iterator data */
UPROPS_SRC_NFC_CANON_ITER,
// Text layout properties.
UPROPS_SRC_INPC,
UPROPS_SRC_INSC,
UPROPS_SRC_VO,
UPROPS_SRC_EMOJI,
UPROPS_SRC_IDSU,
UPROPS_SRC_ID_COMPAT_MATH,
UPROPS_SRC_BLOCK,
UPROPS_SRC_MCM,
/** One more than the highest UPropertySource (UPROPS_SRC_) constant. */
UPROPS_SRC_COUNT
};
typedef enum UPropertySource UPropertySource;
/**
* @see UPropertySource
* @internal
*/
U_CFUNC UPropertySource U_EXPORT2
uprops_getSource(UProperty which);
/**
* Enumerate uprops.icu's main data trie and add the
* start of each range of same properties to the set.
* @internal
*/
U_CFUNC void U_EXPORT2
uchar_addPropertyStarts(const USetAdder *sa, UErrorCode *pErrorCode);
/**
* Enumerate uprops.icu's properties vectors trie and add the
* start of each range of same properties to the set.
* @internal
*/
U_CFUNC void U_EXPORT2
upropsvec_addPropertyStarts(const USetAdder *sa, UErrorCode *pErrorCode);
U_CFUNC void U_EXPORT2
uprops_addPropertyStarts(UPropertySource src, const USetAdder *sa, UErrorCode *pErrorCode);
#ifdef __cplusplus
U_CFUNC void U_EXPORT2
ublock_addPropertyStarts(const USetAdder *sa, UErrorCode &errorCode);
#endif // __cplusplus
/**
* Return a set of characters for property enumeration.
* For each two consecutive characters (start, limit) in the set,
* all of the properties for start..limit-1 are all the same.
*
* @param sa USetAdder to receive result. Existing contents are lost.
* @internal
*/
/*U_CFUNC void U_EXPORT2
uprv_getInclusions(const USetAdder *sa, UErrorCode *pErrorCode);
*/
// TODO: Move this into a different header file (udataswp.h? new unames.h?) so that uprops.h
// need not be C-compatible any more.
/**
* Swap the ICU Unicode character names file. See uchar.c.
* @internal
*/
U_CAPI int32_t U_EXPORT2
uchar_swapNames(const UDataSwapper *ds,
const void *inData, int32_t length, void *outData,
UErrorCode *pErrorCode);
#ifdef __cplusplus
U_NAMESPACE_BEGIN
class UnicodeSet;
class CharacterProperties {
public:
CharacterProperties() = delete;
static const UnicodeSet *getInclusionsForProperty(UProperty prop, UErrorCode &errorCode);
static const UnicodeSet *getBinaryPropertySet(UProperty property, UErrorCode &errorCode);
};
// implemented in uniset_props.cpp
U_CFUNC UnicodeSet *
uniset_getUnicode32Instance(UErrorCode &errorCode);
U_NAMESPACE_END
#endif
#endif
|