annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/unicode/uconfig.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 // © 2016 and later: Unicode, Inc. and others.
jpayne@69 2 // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69 3 /*
jpayne@69 4 **********************************************************************
jpayne@69 5 * Copyright (C) 2002-2016, International Business Machines
jpayne@69 6 * Corporation and others. All Rights Reserved.
jpayne@69 7 **********************************************************************
jpayne@69 8 * file name: uconfig.h
jpayne@69 9 * encoding: UTF-8
jpayne@69 10 * tab size: 8 (not used)
jpayne@69 11 * indentation:4
jpayne@69 12 *
jpayne@69 13 * created on: 2002sep19
jpayne@69 14 * created by: Markus W. Scherer
jpayne@69 15 */
jpayne@69 16
jpayne@69 17 #ifndef __UCONFIG_H__
jpayne@69 18 #define __UCONFIG_H__
jpayne@69 19
jpayne@69 20
jpayne@69 21 /*!
jpayne@69 22 * \file
jpayne@69 23 * \brief User-configurable settings
jpayne@69 24 *
jpayne@69 25 * Miscellaneous switches:
jpayne@69 26 *
jpayne@69 27 * A number of macros affect a variety of minor aspects of ICU.
jpayne@69 28 * Most of them used to be defined elsewhere (e.g., in utypes.h or platform.h)
jpayne@69 29 * and moved here to make them easier to find.
jpayne@69 30 *
jpayne@69 31 * Switches for excluding parts of ICU library code modules:
jpayne@69 32 *
jpayne@69 33 * Changing these macros allows building partial, smaller libraries for special purposes.
jpayne@69 34 * By default, all modules are built.
jpayne@69 35 * The switches are fairly coarse, controlling large modules.
jpayne@69 36 * Basic services cannot be turned off.
jpayne@69 37 *
jpayne@69 38 * Building with any of these options does not guarantee that the
jpayne@69 39 * ICU build process will completely work. It is recommended that
jpayne@69 40 * the ICU libraries and data be built using the normal build.
jpayne@69 41 * At that time you should remove the data used by those services.
jpayne@69 42 * After building the ICU data library, you should rebuild the ICU
jpayne@69 43 * libraries with these switches customized to your needs.
jpayne@69 44 *
jpayne@69 45 * @stable ICU 2.4
jpayne@69 46 */
jpayne@69 47
jpayne@69 48 /**
jpayne@69 49 * If this switch is defined, ICU will attempt to load a header file named "uconfig_local.h"
jpayne@69 50 * prior to determining default settings for uconfig variables.
jpayne@69 51 *
jpayne@69 52 * @internal ICU 4.0
jpayne@69 53 */
jpayne@69 54 #if defined(UCONFIG_USE_LOCAL)
jpayne@69 55 #include "uconfig_local.h"
jpayne@69 56 #endif
jpayne@69 57
jpayne@69 58 /**
jpayne@69 59 * \def U_DEBUG
jpayne@69 60 * Determines whether to include debugging code.
jpayne@69 61 * Automatically set on Windows, but most compilers do not have
jpayne@69 62 * related predefined macros.
jpayne@69 63 * @internal
jpayne@69 64 */
jpayne@69 65 #ifdef U_DEBUG
jpayne@69 66 /* Use the predefined value. */
jpayne@69 67 #elif defined(_DEBUG)
jpayne@69 68 /*
jpayne@69 69 * _DEBUG is defined by Visual Studio debug compilation.
jpayne@69 70 * Do *not* test for its NDEBUG macro: It is an orthogonal macro
jpayne@69 71 * which disables assert().
jpayne@69 72 */
jpayne@69 73 # define U_DEBUG 1
jpayne@69 74 # else
jpayne@69 75 # define U_DEBUG 0
jpayne@69 76 #endif
jpayne@69 77
jpayne@69 78 /**
jpayne@69 79 * Determines whether to enable auto cleanup of libraries.
jpayne@69 80 * @internal
jpayne@69 81 */
jpayne@69 82 #ifndef UCLN_NO_AUTO_CLEANUP
jpayne@69 83 #define UCLN_NO_AUTO_CLEANUP 1
jpayne@69 84 #endif
jpayne@69 85
jpayne@69 86 /**
jpayne@69 87 * \def U_DISABLE_RENAMING
jpayne@69 88 * Determines whether to disable renaming or not.
jpayne@69 89 * @internal
jpayne@69 90 */
jpayne@69 91 #ifndef U_DISABLE_RENAMING
jpayne@69 92 #define U_DISABLE_RENAMING 0
jpayne@69 93 #endif
jpayne@69 94
jpayne@69 95 /**
jpayne@69 96 * \def U_NO_DEFAULT_INCLUDE_UTF_HEADERS
jpayne@69 97 * Determines whether utypes.h includes utf.h, utf8.h, utf16.h and utf_old.h.
jpayne@69 98 * utypes.h includes those headers if this macro is defined to 0.
jpayne@69 99 * Otherwise, each those headers must be included explicitly when using one of their macros.
jpayne@69 100 * Defaults to 0 for backward compatibility, except inside ICU.
jpayne@69 101 * @stable ICU 49
jpayne@69 102 */
jpayne@69 103 #ifdef U_NO_DEFAULT_INCLUDE_UTF_HEADERS
jpayne@69 104 /* Use the predefined value. */
jpayne@69 105 #elif defined(U_COMBINED_IMPLEMENTATION) || defined(U_COMMON_IMPLEMENTATION) || defined(U_I18N_IMPLEMENTATION) || \
jpayne@69 106 defined(U_IO_IMPLEMENTATION) || defined(U_LAYOUT_IMPLEMENTATION) || defined(U_LAYOUTEX_IMPLEMENTATION) || \
jpayne@69 107 defined(U_TOOLUTIL_IMPLEMENTATION)
jpayne@69 108 # define U_NO_DEFAULT_INCLUDE_UTF_HEADERS 1
jpayne@69 109 #else
jpayne@69 110 # define U_NO_DEFAULT_INCLUDE_UTF_HEADERS 0
jpayne@69 111 #endif
jpayne@69 112
jpayne@69 113 /**
jpayne@69 114 * \def U_OVERRIDE_CXX_ALLOCATION
jpayne@69 115 * Determines whether to override new and delete.
jpayne@69 116 * ICU is normally built such that all of its C++ classes, via their UMemory base,
jpayne@69 117 * override operators new and delete to use its internal, customizable,
jpayne@69 118 * non-exception-throwing memory allocation functions. (Default value 1 for this macro.)
jpayne@69 119 *
jpayne@69 120 * This is especially important when the application and its libraries use multiple heaps.
jpayne@69 121 * For example, on Windows, this allows the ICU DLL to be used by
jpayne@69 122 * applications that statically link the C Runtime library.
jpayne@69 123 *
jpayne@69 124 * @stable ICU 2.2
jpayne@69 125 */
jpayne@69 126 #ifndef U_OVERRIDE_CXX_ALLOCATION
jpayne@69 127 #define U_OVERRIDE_CXX_ALLOCATION 1
jpayne@69 128 #endif
jpayne@69 129
jpayne@69 130 /**
jpayne@69 131 * \def U_ENABLE_TRACING
jpayne@69 132 * Determines whether to enable tracing.
jpayne@69 133 * @internal
jpayne@69 134 */
jpayne@69 135 #ifndef U_ENABLE_TRACING
jpayne@69 136 #define U_ENABLE_TRACING 0
jpayne@69 137 #endif
jpayne@69 138
jpayne@69 139 /**
jpayne@69 140 * \def UCONFIG_ENABLE_PLUGINS
jpayne@69 141 * Determines whether to enable ICU plugins.
jpayne@69 142 * @internal
jpayne@69 143 */
jpayne@69 144 #ifndef UCONFIG_ENABLE_PLUGINS
jpayne@69 145 #define UCONFIG_ENABLE_PLUGINS 0
jpayne@69 146 #endif
jpayne@69 147
jpayne@69 148 /**
jpayne@69 149 * \def U_ENABLE_DYLOAD
jpayne@69 150 * Whether to enable Dynamic loading in ICU.
jpayne@69 151 * @internal
jpayne@69 152 */
jpayne@69 153 #ifndef U_ENABLE_DYLOAD
jpayne@69 154 #define U_ENABLE_DYLOAD 1
jpayne@69 155 #endif
jpayne@69 156
jpayne@69 157 /**
jpayne@69 158 * \def U_CHECK_DYLOAD
jpayne@69 159 * Whether to test Dynamic loading as an OS capability.
jpayne@69 160 * @internal
jpayne@69 161 */
jpayne@69 162 #ifndef U_CHECK_DYLOAD
jpayne@69 163 #define U_CHECK_DYLOAD 1
jpayne@69 164 #endif
jpayne@69 165
jpayne@69 166 /**
jpayne@69 167 * \def U_DEFAULT_SHOW_DRAFT
jpayne@69 168 * Do we allow ICU users to use the draft APIs by default?
jpayne@69 169 * @internal
jpayne@69 170 */
jpayne@69 171 #ifndef U_DEFAULT_SHOW_DRAFT
jpayne@69 172 #define U_DEFAULT_SHOW_DRAFT 1
jpayne@69 173 #endif
jpayne@69 174
jpayne@69 175 /*===========================================================================*/
jpayne@69 176 /* Custom icu entry point renaming */
jpayne@69 177 /*===========================================================================*/
jpayne@69 178
jpayne@69 179 /**
jpayne@69 180 * \def U_HAVE_LIB_SUFFIX
jpayne@69 181 * 1 if a custom library suffix is set.
jpayne@69 182 * @internal
jpayne@69 183 */
jpayne@69 184 #ifdef U_HAVE_LIB_SUFFIX
jpayne@69 185 /* Use the predefined value. */
jpayne@69 186 #elif defined(U_LIB_SUFFIX_C_NAME) || defined(U_IN_DOXYGEN)
jpayne@69 187 # define U_HAVE_LIB_SUFFIX 1
jpayne@69 188 #endif
jpayne@69 189
jpayne@69 190 /**
jpayne@69 191 * \def U_LIB_SUFFIX_C_NAME_STRING
jpayne@69 192 * Defines the library suffix as a string with C syntax.
jpayne@69 193 * @internal
jpayne@69 194 */
jpayne@69 195 #ifdef U_LIB_SUFFIX_C_NAME_STRING
jpayne@69 196 /* Use the predefined value. */
jpayne@69 197 #elif defined(U_LIB_SUFFIX_C_NAME)
jpayne@69 198 # define CONVERT_TO_STRING(s) #s
jpayne@69 199 # define U_LIB_SUFFIX_C_NAME_STRING CONVERT_TO_STRING(U_LIB_SUFFIX_C_NAME)
jpayne@69 200 #else
jpayne@69 201 # define U_LIB_SUFFIX_C_NAME_STRING ""
jpayne@69 202 #endif
jpayne@69 203
jpayne@69 204 /* common/i18n library switches --------------------------------------------- */
jpayne@69 205
jpayne@69 206 /**
jpayne@69 207 * \def UCONFIG_ONLY_COLLATION
jpayne@69 208 * This switch turns off modules that are not needed for collation.
jpayne@69 209 *
jpayne@69 210 * It does not turn off legacy conversion because that is necessary
jpayne@69 211 * for ICU to work on EBCDIC platforms (for the default converter).
jpayne@69 212 * If you want "only collation" and do not build for EBCDIC,
jpayne@69 213 * then you can define UCONFIG_NO_CONVERSION or UCONFIG_NO_LEGACY_CONVERSION to 1 as well.
jpayne@69 214 *
jpayne@69 215 * @stable ICU 2.4
jpayne@69 216 */
jpayne@69 217 #ifndef UCONFIG_ONLY_COLLATION
jpayne@69 218 # define UCONFIG_ONLY_COLLATION 0
jpayne@69 219 #endif
jpayne@69 220
jpayne@69 221 #if UCONFIG_ONLY_COLLATION
jpayne@69 222 /* common library */
jpayne@69 223 # define UCONFIG_NO_BREAK_ITERATION 1
jpayne@69 224 # define UCONFIG_NO_IDNA 1
jpayne@69 225
jpayne@69 226 /* i18n library */
jpayne@69 227 # if UCONFIG_NO_COLLATION
jpayne@69 228 # error Contradictory collation switches in uconfig.h.
jpayne@69 229 # endif
jpayne@69 230 # define UCONFIG_NO_FORMATTING 1
jpayne@69 231 # define UCONFIG_NO_TRANSLITERATION 1
jpayne@69 232 # define UCONFIG_NO_REGULAR_EXPRESSIONS 1
jpayne@69 233 #endif
jpayne@69 234
jpayne@69 235 /* common library switches -------------------------------------------------- */
jpayne@69 236
jpayne@69 237 /**
jpayne@69 238 * \def UCONFIG_NO_FILE_IO
jpayne@69 239 * This switch turns off all file access in the common library
jpayne@69 240 * where file access is only used for data loading.
jpayne@69 241 * ICU data must then be provided in the form of a data DLL (or with an
jpayne@69 242 * equivalent way to link to the data residing in an executable,
jpayne@69 243 * as in building a combined library with both the common library's code and
jpayne@69 244 * the data), or via udata_setCommonData().
jpayne@69 245 * Application data must be provided via udata_setAppData() or by using
jpayne@69 246 * "open" functions that take pointers to data, for example ucol_openBinary().
jpayne@69 247 *
jpayne@69 248 * File access is not used at all in the i18n library.
jpayne@69 249 *
jpayne@69 250 * File access cannot be turned off for the icuio library or for the ICU
jpayne@69 251 * test suites and ICU tools.
jpayne@69 252 *
jpayne@69 253 * @stable ICU 3.6
jpayne@69 254 */
jpayne@69 255 #ifndef UCONFIG_NO_FILE_IO
jpayne@69 256 # define UCONFIG_NO_FILE_IO 0
jpayne@69 257 #endif
jpayne@69 258
jpayne@69 259 #if UCONFIG_NO_FILE_IO && defined(U_TIMEZONE_FILES_DIR)
jpayne@69 260 # error Contradictory file io switches in uconfig.h.
jpayne@69 261 #endif
jpayne@69 262
jpayne@69 263 /**
jpayne@69 264 * \def UCONFIG_NO_CONVERSION
jpayne@69 265 * ICU will not completely build (compiling the tools fails) with this
jpayne@69 266 * switch turned on.
jpayne@69 267 * This switch turns off all converters.
jpayne@69 268 *
jpayne@69 269 * You may want to use this together with U_CHARSET_IS_UTF8 defined to 1
jpayne@69 270 * in utypes.h if char* strings in your environment are always in UTF-8.
jpayne@69 271 *
jpayne@69 272 * @stable ICU 3.2
jpayne@69 273 * @see U_CHARSET_IS_UTF8
jpayne@69 274 */
jpayne@69 275 #ifndef UCONFIG_NO_CONVERSION
jpayne@69 276 # define UCONFIG_NO_CONVERSION 0
jpayne@69 277 #endif
jpayne@69 278
jpayne@69 279 #if UCONFIG_NO_CONVERSION
jpayne@69 280 # define UCONFIG_NO_LEGACY_CONVERSION 1
jpayne@69 281 #endif
jpayne@69 282
jpayne@69 283 /**
jpayne@69 284 * \def UCONFIG_ONLY_HTML_CONVERSION
jpayne@69 285 * This switch turns off all of the converters NOT listed in
jpayne@69 286 * the HTML encoding standard:
jpayne@69 287 * http://www.w3.org/TR/encoding/#names-and-labels
jpayne@69 288 *
jpayne@69 289 * This is not possible on EBCDIC platforms
jpayne@69 290 * because they need ibm-37 or ibm-1047 default converters.
jpayne@69 291 *
jpayne@69 292 * @stable ICU 55
jpayne@69 293 */
jpayne@69 294 #ifndef UCONFIG_ONLY_HTML_CONVERSION
jpayne@69 295 # define UCONFIG_ONLY_HTML_CONVERSION 0
jpayne@69 296 #endif
jpayne@69 297
jpayne@69 298 /**
jpayne@69 299 * \def UCONFIG_NO_LEGACY_CONVERSION
jpayne@69 300 * This switch turns off all converters except for
jpayne@69 301 * - Unicode charsets (UTF-7/8/16/32, CESU-8, SCSU, BOCU-1)
jpayne@69 302 * - US-ASCII
jpayne@69 303 * - ISO-8859-1
jpayne@69 304 *
jpayne@69 305 * Turning off legacy conversion is not possible on EBCDIC platforms
jpayne@69 306 * because they need ibm-37 or ibm-1047 default converters.
jpayne@69 307 *
jpayne@69 308 * @stable ICU 2.4
jpayne@69 309 */
jpayne@69 310 #ifndef UCONFIG_NO_LEGACY_CONVERSION
jpayne@69 311 # define UCONFIG_NO_LEGACY_CONVERSION 0
jpayne@69 312 #endif
jpayne@69 313
jpayne@69 314 /**
jpayne@69 315 * \def UCONFIG_NO_NORMALIZATION
jpayne@69 316 * This switch turns off normalization.
jpayne@69 317 * It implies turning off several other services as well, for example
jpayne@69 318 * collation and IDNA.
jpayne@69 319 *
jpayne@69 320 * @stable ICU 2.6
jpayne@69 321 */
jpayne@69 322 #ifndef UCONFIG_NO_NORMALIZATION
jpayne@69 323 # define UCONFIG_NO_NORMALIZATION 0
jpayne@69 324 #endif
jpayne@69 325
jpayne@69 326 #if UCONFIG_NO_NORMALIZATION
jpayne@69 327 /* common library */
jpayne@69 328 /* ICU 50 CJK dictionary BreakIterator uses normalization */
jpayne@69 329 # define UCONFIG_NO_BREAK_ITERATION 1
jpayne@69 330 /* IDNA (UTS #46) is implemented via normalization */
jpayne@69 331 # define UCONFIG_NO_IDNA 1
jpayne@69 332
jpayne@69 333 /* i18n library */
jpayne@69 334 # if UCONFIG_ONLY_COLLATION
jpayne@69 335 # error Contradictory collation switches in uconfig.h.
jpayne@69 336 # endif
jpayne@69 337 # define UCONFIG_NO_COLLATION 1
jpayne@69 338 # define UCONFIG_NO_TRANSLITERATION 1
jpayne@69 339 #endif
jpayne@69 340
jpayne@69 341 /**
jpayne@69 342 * \def UCONFIG_NO_BREAK_ITERATION
jpayne@69 343 * This switch turns off break iteration.
jpayne@69 344 *
jpayne@69 345 * @stable ICU 2.4
jpayne@69 346 */
jpayne@69 347 #ifndef UCONFIG_NO_BREAK_ITERATION
jpayne@69 348 # define UCONFIG_NO_BREAK_ITERATION 0
jpayne@69 349 #endif
jpayne@69 350
jpayne@69 351 /**
jpayne@69 352 * \def UCONFIG_NO_IDNA
jpayne@69 353 * This switch turns off IDNA.
jpayne@69 354 *
jpayne@69 355 * @stable ICU 2.6
jpayne@69 356 */
jpayne@69 357 #ifndef UCONFIG_NO_IDNA
jpayne@69 358 # define UCONFIG_NO_IDNA 0
jpayne@69 359 #endif
jpayne@69 360
jpayne@69 361 /**
jpayne@69 362 * \def UCONFIG_MSGPAT_DEFAULT_APOSTROPHE_MODE
jpayne@69 363 * Determines the default UMessagePatternApostropheMode.
jpayne@69 364 * See the documentation for that enum.
jpayne@69 365 *
jpayne@69 366 * @stable ICU 4.8
jpayne@69 367 */
jpayne@69 368 #ifndef UCONFIG_MSGPAT_DEFAULT_APOSTROPHE_MODE
jpayne@69 369 # define UCONFIG_MSGPAT_DEFAULT_APOSTROPHE_MODE UMSGPAT_APOS_DOUBLE_OPTIONAL
jpayne@69 370 #endif
jpayne@69 371
jpayne@69 372 /**
jpayne@69 373 * \def UCONFIG_USE_WINDOWS_LCID_MAPPING_API
jpayne@69 374 * On platforms where U_PLATFORM_HAS_WIN32_API is true, this switch determines
jpayne@69 375 * if the Windows platform APIs are used for LCID<->Locale Name conversions.
jpayne@69 376 * Otherwise, only the built-in ICU tables are used.
jpayne@69 377 *
jpayne@69 378 * @internal ICU 64
jpayne@69 379 */
jpayne@69 380 #ifndef UCONFIG_USE_WINDOWS_LCID_MAPPING_API
jpayne@69 381 # define UCONFIG_USE_WINDOWS_LCID_MAPPING_API 1
jpayne@69 382 #endif
jpayne@69 383
jpayne@69 384 /* i18n library switches ---------------------------------------------------- */
jpayne@69 385
jpayne@69 386 /**
jpayne@69 387 * \def UCONFIG_NO_COLLATION
jpayne@69 388 * This switch turns off collation and collation-based string search.
jpayne@69 389 *
jpayne@69 390 * @stable ICU 2.4
jpayne@69 391 */
jpayne@69 392 #ifndef UCONFIG_NO_COLLATION
jpayne@69 393 # define UCONFIG_NO_COLLATION 0
jpayne@69 394 #endif
jpayne@69 395
jpayne@69 396 /**
jpayne@69 397 * \def UCONFIG_NO_FORMATTING
jpayne@69 398 * This switch turns off formatting and calendar/timezone services.
jpayne@69 399 *
jpayne@69 400 * @stable ICU 2.4
jpayne@69 401 */
jpayne@69 402 #ifndef UCONFIG_NO_FORMATTING
jpayne@69 403 # define UCONFIG_NO_FORMATTING 0
jpayne@69 404 #endif
jpayne@69 405
jpayne@69 406 /**
jpayne@69 407 * \def UCONFIG_NO_TRANSLITERATION
jpayne@69 408 * This switch turns off transliteration.
jpayne@69 409 *
jpayne@69 410 * @stable ICU 2.4
jpayne@69 411 */
jpayne@69 412 #ifndef UCONFIG_NO_TRANSLITERATION
jpayne@69 413 # define UCONFIG_NO_TRANSLITERATION 0
jpayne@69 414 #endif
jpayne@69 415
jpayne@69 416 /**
jpayne@69 417 * \def UCONFIG_NO_REGULAR_EXPRESSIONS
jpayne@69 418 * This switch turns off regular expressions.
jpayne@69 419 *
jpayne@69 420 * @stable ICU 2.4
jpayne@69 421 */
jpayne@69 422 #ifndef UCONFIG_NO_REGULAR_EXPRESSIONS
jpayne@69 423 # define UCONFIG_NO_REGULAR_EXPRESSIONS 0
jpayne@69 424 #endif
jpayne@69 425
jpayne@69 426 /**
jpayne@69 427 * \def UCONFIG_NO_SERVICE
jpayne@69 428 * This switch turns off service registration.
jpayne@69 429 *
jpayne@69 430 * @stable ICU 3.2
jpayne@69 431 */
jpayne@69 432 #ifndef UCONFIG_NO_SERVICE
jpayne@69 433 # define UCONFIG_NO_SERVICE 0
jpayne@69 434 #endif
jpayne@69 435
jpayne@69 436 /**
jpayne@69 437 * \def UCONFIG_HAVE_PARSEALLINPUT
jpayne@69 438 * This switch turns on the "parse all input" attribute. Binary incompatible.
jpayne@69 439 *
jpayne@69 440 * @internal
jpayne@69 441 */
jpayne@69 442 #ifndef UCONFIG_HAVE_PARSEALLINPUT
jpayne@69 443 # define UCONFIG_HAVE_PARSEALLINPUT 1
jpayne@69 444 #endif
jpayne@69 445
jpayne@69 446 /**
jpayne@69 447 * \def UCONFIG_NO_FILTERED_BREAK_ITERATION
jpayne@69 448 * This switch turns off filtered break iteration code.
jpayne@69 449 *
jpayne@69 450 * @internal
jpayne@69 451 */
jpayne@69 452 #ifndef UCONFIG_NO_FILTERED_BREAK_ITERATION
jpayne@69 453 # define UCONFIG_NO_FILTERED_BREAK_ITERATION 0
jpayne@69 454 #endif
jpayne@69 455
jpayne@69 456 #endif // __UCONFIG_H__