]> git.saurik.com Git - apple/icu.git/blobdiff - icuSources/common/unicode/uconfig.h
ICU-461.12.tar.gz
[apple/icu.git] / icuSources / common / unicode / uconfig.h
index b951101bce969bf8795cee6412ee331dbbb5d6a4..6521eed472d792e4a4c8ef6a2da52a0134004561 100644 (file)
@@ -1,6 +1,6 @@
 /*  
 **********************************************************************
-*   Copyright (C) 2002-2003, International Business Machines
+*   Copyright (C) 2002-2009, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 **********************************************************************
 *   file name:  uconfig.h
@@ -15,6 +15,7 @@
 #ifndef __UCONFIG_H__
 #define __UCONFIG_H__
 
+
 /*!
  * \file
  * \brief Switches for excluding parts of ICU library code modules.
  * The switches are fairly coarse, controlling large modules.
  * Basic services cannot be turned off.
  *
- * @draft ICU 2.4
+ * Building with any of these options does not guarantee that the
+ * ICU build process will completely work. It is recommended that
+ * the ICU libraries and data be built using the normal build.
+ * At that time you should remove the data used by those services.
+ * After building the ICU data library, you should rebuild the ICU
+ * libraries with these switches customized to your needs.
+ *
+ * @stable ICU 2.4
  */
 
+/**
+ * If this switch is defined, ICU will attempt to load a header file named "uconfig_local.h"
+ * prior to determining default settings for uconfig variables.
+ * 
+ * @internal ICU 4.0
+ * 
+ */
+#if defined(UCONFIG_USE_LOCAL)
+#include "uconfig_local.h"
+#endif
+
 /**
  * \def UCONFIG_ONLY_COLLATION
  * This switch turns off modules that are not needed for collation.
@@ -34,9 +53,9 @@
  * It does not turn off legacy conversion because that is necessary
  * for ICU to work on EBCDIC platforms (for the default converter).
  * If you want "only collation" and do not build for EBCDIC,
- * then you can #define UCONFIG_NO_LEGACY_CONVERSION 1 as well.
+ * then you can define UCONFIG_NO_LEGACY_CONVERSION 1 as well.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_ONLY_COLLATION
 #   define UCONFIG_ONLY_COLLATION 0
 
 /* common library switches -------------------------------------------------- */
 
+/**
+ * \def UCONFIG_NO_FILE_IO
+ * This switch turns off all file access in the common library
+ * where file access is only used for data loading.
+ * ICU data must then be provided in the form of a data DLL (or with an
+ * equivalent way to link to the data residing in an executable,
+ * as in building a combined library with both the common library's code and
+ * the data), or via udata_setCommonData().
+ * Application data must be provided via udata_setAppData() or by using
+ * "open" functions that take pointers to data, for example ucol_openBinary().
+ *
+ * File access is not used at all in the i18n library.
+ *
+ * File access cannot be turned off for the icuio library or for the ICU
+ * test suites and ICU tools.
+ *
+ * @stable ICU 3.6
+ */
+#ifndef UCONFIG_NO_FILE_IO
+#   define UCONFIG_NO_FILE_IO 0
+#endif
+
+/**
+ * \def UCONFIG_NO_CONVERSION
+ * ICU will not completely build with this switch turned on.
+ * This switch turns off all converters.
+ *
+ * You may want to use this together with U_CHARSET_IS_UTF8 defined to 1
+ * in utypes.h if char* strings in your environment are always in UTF-8.
+ *
+ * @stable ICU 3.2
+ * @see U_CHARSET_IS_UTF8
+ */
+#ifndef UCONFIG_NO_CONVERSION
+#   define UCONFIG_NO_CONVERSION 0
+#endif
+
+#if UCONFIG_NO_CONVERSION
+#   define UCONFIG_NO_LEGACY_CONVERSION 1
+#endif
+
 /**
  * \def UCONFIG_NO_LEGACY_CONVERSION
  * This switch turns off all converters except for
  * Turning off legacy conversion is not possible on EBCDIC platforms
  * because they need ibm-37 or ibm-1047 default converters.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_NO_LEGACY_CONVERSION
 #   define UCONFIG_NO_LEGACY_CONVERSION 0
  * It implies turning off several other services as well, for example
  * collation and IDNA.
  *
- * @draft ICU 2.6
+ * @stable ICU 2.6
  */
 #ifndef UCONFIG_NO_NORMALIZATION
 #   define UCONFIG_NO_NORMALIZATION 0
  * \def UCONFIG_NO_BREAK_ITERATION
  * This switch turns off break iteration.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_NO_BREAK_ITERATION
 #   define UCONFIG_NO_BREAK_ITERATION 0
  * \def UCONFIG_NO_IDNA
  * This switch turns off IDNA.
  *
- * @draft ICU 2.6
+ * @stable ICU 2.6
  */
 #ifndef UCONFIG_NO_IDNA
 #   define UCONFIG_NO_IDNA 0
 /* i18n library switches ---------------------------------------------------- */
 
 /**
- * \def 
+ * \def UCONFIG_NO_COLLATION
  * This switch turns off collation and collation-based string search.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_NO_COLLATION
 #   define UCONFIG_NO_COLLATION 0
  * \def UCONFIG_NO_FORMATTING
  * This switch turns off formatting and calendar/timezone services.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_NO_FORMATTING
 #   define UCONFIG_NO_FORMATTING 0
  * \def UCONFIG_NO_TRANSLITERATION
  * This switch turns off transliteration.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_NO_TRANSLITERATION
 #   define UCONFIG_NO_TRANSLITERATION 0
  * \def UCONFIG_NO_REGULAR_EXPRESSIONS
  * This switch turns off regular expressions.
  *
- * @draft ICU 2.4
+ * @stable ICU 2.4
  */
 #ifndef UCONFIG_NO_REGULAR_EXPRESSIONS
 #   define UCONFIG_NO_REGULAR_EXPRESSIONS 0
 #endif
 
-
+/**
+ * \def UCONFIG_NO_SERVICE
+ * This switch turns off service registration.
+ *
+ * @stable ICU 3.2
+ */
+#ifndef UCONFIG_NO_SERVICE
+#   define UCONFIG_NO_SERVICE 0
+#endif
 
 #endif