{: .no_toc }
{: .no_toc .text-delta }
Depending on the platform and the type of installation, we recommend a small number of modifications and build options. Note that C99 compatibility is now required.
icu::UnicodeString, or do using icu::UnicodeString; where appropriate. If your code relies on the “using namespace icu;” that used to be in unicode/uversion.h, then you need to update your code. You could temporarily (until you have more time to update your code) revert to the default “using” via -DU_USING_ICU_NAMESPACE=1 or by modifying unicode/uversion.h: Index: icu4c/source/common/unicode/uversion.h
===================================================================
--- icu4c/source/common/unicode/uversion.h (revision 40704)
+++ icu4c/source/common/unicode/uversion.h (working copy)
@@ -127,7 +127,7 @@
defined(U_LAYOUTEX_IMPLEMENTATION) || defined(U_TOOLUTIL_IMPLEMENTATION)
# define U_USING_ICU_NAMESPACE 0
# else
-# define U_USING_ICU_NAMESPACE 0
+# define U_USING_ICU_NAMESPACE 1
# endif
# endif
# if U_USING_ICU_NAMESPACE
-DU_USING_ICU_NAMESPACE=0 or by modifying unicode/uversion.h: Index: source/common/unicode/uversion.h
===================================================================
--- source/common/unicode/uversion.h (revision 26606)
+++ source/common/unicode/uversion.h (working copy)
@@ -180,7 +180,8 @@
# define U_NAMESPACE_QUALIFIER U_ICU_NAMESPACE::
# ifndef U_USING_ICU_NAMESPACE
-# define U_USING_ICU_NAMESPACE 1
+ // Set to 0 to force namespace declarations in ICU usage.
+# define U_USING_ICU_NAMESPACE 0
# endif
# if U_USING_ICU_NAMESPACE
U_NAMESPACE_USE
ICU call sites then either qualify ICU types explicitly, for example `icu::UnicodeString`, or do `using icu::UnicodeString;` where appropriate.
-DU_CHARSET_IS_UTF8=1 or modify unicode/utypes.h (in ICU 4.8 and below) or modify unicode/platform.h (in ICU 49 and higher): Index: source/common/unicode/utypes.h
===================================================================
--- source/common/unicode/utypes.h (revision 26606)
+++ source/common/unicode/utypes.h (working copy)
@@ -160,7 +160,7 @@
* @see UCONFIG_NO_CONVERSION
*/
#ifndef U_CHARSET_IS_UTF8
-# define U_CHARSET_IS_UTF8 0
+# define U_CHARSET_IS_UTF8 1
#endif
/*===========================================================================*/
UnicodeString with a single character by using an integer, and it can lead to inadvertent dependency on the conversion framework by using a C string literal. Beginning with ICU 49, you should do the following:UChar and from-UChar32 constructors explicit via -DUNISTR_FROM_CHAR_EXPLICIT=explicit or similar.const char* and from-const UChar* constructors explicit via -DUNISTR_FROM_STRING_EXPLICIT=explicit or similar.:point_right: Note: The ICU test suites cannot be compiled with these settings.
U_NO_DEFAULT_INCLUDE_UTF_HEADERS to 1 (via -D or uconfig.h, as above) and include those header files explicitly that you actually need.:point_right: Note: The ICU test suites cannot be compiled with this setting.
U_HIDE_OBSOLETE_UTF_OLD_H to 1 (via -D or uconfig.h, as above). Use of any of these macros should be replaced as noted in the comments for the obsolete macro.:point_right: Note: The ICU test suites can be compiled with this setting.
u_setDataDirectory()) or with a pointer to the data (udata_setCommonData()) before other ICU API calls. This is usually easy if ICU is used from an application where main() takes care of such initialization. It may be hard if ICU is shipped with another shared library (such as the Xerces-C++ XML parser) which does not control main(). See the User Guide ICU Data chapter for more details. If possible, we recommend building the .dat package. Specify --with-data-packaging=archive on the configure command line, as in runConfigureICU Linux --with-data-packaging=archive (Read the configure script's output for further instructions. On Windows, the Visual Studio build generates both the .dat package and the data DLL.) Be sure to install and use the tiny stubdata library rather than the large data DLL.runConfigureICU Linux --enable-static --disable-shared ~/icu$ git clone https://github.com/unicode-org/icu.git
~/icu$ mkdir icu4c-build
~/icu$ cd icu4c-build
~/icu/icu4c-build$ ../icu/icu4c/source/runConfigureICU Linux
~/icu/icu4c-build$ make check
> :point_right: **Note**: this example shows a relative path to `runConfigureICU`. If you experience difficulty, try using an absolute path to `runConfigureICU` instead.
If ICU is installed as a system-level library, there are further opportunities and restrictions to consider. For details, see the Using ICU as an Operating System Level Library section of the User Guide ICU Architectural Design chapter.
U_ICU_DATA_DEFAULT_DIR. Alternatively, you can set -DICU_DATA_DIR=/path/to/icu/data when building the ICU code. (Used by source/common/putil.c.) Consider also setting -DICU_NO_USER_DATA_OVERRIDE if you do not want the ICU_DATA environment variable to be used. (An application can still override the data path via u_setDataDirectory() or udata_setCommonData().@draft is new and not yet stable. Applications must not rely on unstable APIs from a system-level library. Define U_HIDE_DRAFT_API, U_HIDE_INTERNAL_API and U_HIDE_SYSTEM_API by modifying unicode/utypes.h before installing it.\brief C++ API. Consider not installing these header files, or define U_SHOW_CPLUSPLUS_API to be 0 by modifying unicode/utypes.h before installing it.runConfigureICU Linux --disable-renaming The public header files from this configuration must be installed for applications to include and get the correct entry point names.ICU4C can be customized via a number of user-configurable settings. Many of them are controlled by preprocessor macros which are defined in the source/common/unicode/uconfig.h header file. Some turn off parts of ICU, for example conversion or collation, trading off a smaller library for reduced functionality. Other settings are recommended (see previous section) but their default values are set for better source code compatibility.
In order to change such user-configurable settings, you can either modify the uconfig.h header file by adding a specific #define ... for one or more of the macros before they are first tested, or set the compiler's preprocessor flags (CPPFLAGS) to include an equivalent -D macro definition.
Building International Components for Unicode requires:
Notes regarding Windows specific issues:
When using “@compat=host” on versions of Windows below Windows 10 version 1703, there are 6 locales with date and number formatting issues (#13119).
The LCID conversion APIs don't round-trip Kurdish (ku) and Central Kurdish (ckb) due to Windows not having a ckb locale (#20181).
:point_right: Note: Cygwin is required if using a version of MSVC other than the one compatible with the supplied project files or if other compilers are used to build ICU. (e.g. GCC)
The steps are:
Unzip the icu-XXXX.zip file into any convenient location.
Be sure that the ICU binary directory, (ex: <ICU>\bin\), is included in the PATH environment variable. The tests will not work without the location of the ICU DLL files in the path. Note that the binary directory name can depend on what architecture you select when you compile ICU. For x86 or 32-bit builds, the binary directory is bin. Whereas for x64 or 64-bit builds the binary directory is bin64.
Open the <ICU>\source\allinone\allinone.sln solution file in ‘Visual Studio 2017’. (This solution includes all the International Components for Unicode libraries, necessary ICU building tools, and the test suite projects). Please see the command line note below if you want to build from the command line instead.
If you are building using ‘Visual Studio 2015’ instead, or if you are building the UWP projects and you have a different version of the Windows 10 SDK installed you will first need to modify the two Build.Windows.*.props files in the allinone directory before you can open the “allinone” solution file. Please see the notes below about building with other versions of Visual Studio and the notes on re-targeting the Windows 10 SDK for the UWP projects for details. Alternatively, you can skip building the UWP projects entirely as well.
Set the active platform to “Win32” or “x64” (See Windows platform note below) and configuration to “Debug” or “Release” (See Windows configuration note below).
Choose the “Build” menu and select “Rebuild Solution”. If you want to build the Debug and Release at the same time, see the batch configuration note below.
Run the tests. They can be run from the command line or from within Visual Studio.
The general syntax is:
So, for example for x86 (32-bit) and Debug, use the following:
<ICU>\source\allinone\icucheck.bat x86 Debug
For x86 (32-bit) and Release:
<ICU>\source\allinone\icucheck.bat x86 Release
For x64 (64-bit) and Debug:
<ICU>\source\allinone\icucheck.bat x64 Debug
For x64 (64-bit) and Release:
<ICU>\source\allinone\icucheck.bat x64 Release
intltest. To do this: set the active startup project to “intltest”, and press Ctrl+F5 to run it. Make sure that it passes without any errors.cintltst. To do this: set the active startup project to “cintltst”, and press Ctrl+F5 to run it. Make sure that it passes without any errors.iotest. To do this: set the active startup project to “iotest”, and press Ctrl+F5 to run it. Make sure that it passes without any errors.You are now able to develop applications with ICU by using the libraries and tools in <ICU>\bin\. The headers are in <ICU>\include\ and the link libraries are in <ICU>\lib\. To install the ICU runtime on a machine, or ship it with your application, copy the needed components from <ICU>\bin\ to a location on the system PATH or to your application directory.
The particular version of the MSVC compiler tool-set (and thus the corresponding version of Visual Studio) that is used to compile ICU is determined by the PlatformToolset property. This property is stored in two different shared files that are used to set common configuration settings amongst the various ICU *.vcxproj project files. For the non-UWP projects, this setting is in the shared file called Build.Windows.ProjectConfiguration.props located in the allinone directory. For the UWP projects, this setting is in the shared file called Build.Windows.UWP.ProjectConfiguration.props, also located in the allinone directory.
The value of v140 corresponds to the Visual Studio 2015 compiler tool set, whereas the value of v141 corresponds to the Visual Studio 2017 compiler tool set.
In order to build the non-UWP projects with Visual Studio 2015 you will need to modify the file called Build.Windows.ProjectConfiguration.props to change the value of the PlatformToolset property. Note however that Visual Studio 2017 is required for building the UWP projects.
:point_right: Note: Using older versions of the MSVC compiler is generally not recommended due to the improved support for the C++11 standard in newer versions of the compiler.
If the version of the Windows 10 SDK that you have installed does not match the version used by the UWP projects, then you will need to “retarget” them to use the version of the SDK that you have installed instead. There are two ways to do this:
Build.Windows.UWP.ProjectConfiguration.props which is located in the allinone directory. You will need to change the of the WindowsTargetPlatformVersion property to the version of the SDK that you would like to use instead.You can build ICU from the command line instead of using the Visual Studio GUI. Assuming that you have properly installed Visual Studio to support command line building, you should have a shortcut for the “Developer Command Prompt” listed in the Start Menu. (For Visual Studio 2017 you will need to install the “Desktop development with C++” option).
cd) to the ICU source directory.msbuild directly, or you can use the devenv.com command to build ICU.MSBUILD:msbuild source\allinone\allinone.sln /p:Configuration=Debug /p:Platform=Win32
msbuild source\allinone\allinone.sln /p:Configuration=Release /p:Platform=x64
devenv.com:devenv.com source\allinone\allinone.sln /build "Debug|Win32"
devenv.com source\allinone\allinone.sln /build "Release|x64"
You can skip (or omit) building the UWP projects on the command line by passing the argument ‘SkipUWP=true’ to either MSBUILD or devenv.
MSBUILD:msbuild source\allinone\allinone.sln /p:Configuration=Debug /p:Platform=Win32 /p:SkipUWP=true
msbuild source\allinone\allinone.sln /p:Configuration=Release /p:Platform=x64 /p:SkipUWP=true
You can also use Cygwin with the MSVC compiler to build ICU, and you can refer to the How To Build And Install On Windows with Cygwin section for more details.
Even though you are able to select “x64” as the active platform, if your operating system is not a 64 bit version of Windows, the build will fail. To set the active platform, two different possibilities are:
To set the active configuration, two different possibilities are:
If you want to build the Win32 and x64 platforms and Debug and Release configurations at the same time, choose “Build” menu, and select “Batch Build...”. Click the “Select All” button, and then click the “Rebuild” button.
Building International Components for Unicode with this configuration requires:
There are two ways you can build ICU with Cygwin. You can build with gcc or Microsoft Visual C++. If you use gcc, the resulting libraries and tools will depend on the Cygwin environment. If you use Microsoft Visual C++, the resulting libraries and tools do not depend on Cygwin and can be more easily distributed to other Windows computers (the generated man pages and shell scripts still need Cygwin). To build with gcc, please follow the “How To Build And Install On UNIX” instructions, while you are inside a Cygwin bash shell. To build with Microsoft Visual C++, please use the following instructions:
C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\vcvars32.bat can be used for 32-bit builds or C:\Program Files (x86)\Microsoft Visual Studio 14\VC\bin\x86_amd64\vcvarsx86_amd64.bat can be used for 64-bit builds on Windows x64.bash ./runConfigureICU Cygwin/MSVC (See Windows configuration note and non-functional configure options below; see source for ./runConfigureICU).make to compile the libraries and all the data files. This make command should be GNU make.make check to run the test suite, which checks for ICU's functionality integrity (See testing note below).make install to install ICU. If you used the --prefix= option on configure or runConfigureICU, ICU will be installed to the directory you specified. (See installation note below).Ensure that the order of the PATH is MSVC, Cygwin, and then other PATHs. The configure script needs certain tools in Cygwin (e.g. grep).
Also, you may need to run dos2unix.exe on all of the scripts (e.g. configure) in the top source directory of ICU. To avoid this issue, you can download the ICU source for Unix platforms (icu-xxx.tgz).
In addition to the Unix configuration note the following configure options currently do not work on Windows with Microsoft's compiler. Some options can work by manually editing icu/source/common/unicode/pwin32.h, but manually editing the files is not recommended.
--disable-renaming--enable-tracing--enable-rpath--enable-static (Requires that U_STATIC_IMPLEMENTATION be defined in user code that links against ICU's static libraries.)--with-data-packaging=files (The pkgdata tool currently does not work in this mode. Manual packaging is required to use this mode.)Building International Components for Unicode on UNIX requires:
Here are the steps to build ICU:
gunzip -d < icu-_X_._Y_.tgz | tar xvf -
icu/source.cd icu/source
chmod +x runConfigureICU configure install-sh
runConfigureICU script for your platform. (See configuration note below).gmake
(or just `make` if GNU make is the default make on your platform) to compile the libraries and all the data files. The proper name of the GNU make command is printed at the end of the configuration run, as in `"You must use gmake to compile ICU"`. Note that the compilation command output may be simplified on your platform. If this is the case, you will see just: `gcc ... stubdata.c` rather than `gcc -DU_NO_DEFAULT_INCLUDE_UTF_HEADERS=1 -D_REENTRANT -I../common -DU_ATTRIBUTE_DEPRECATED= -O2 -Wall -std=c99 -pedantic -Wshadow -Wpointer-arith -Wmissing-prototypes -Wwrite-strings -c -DPIC -fPIC -o stubdata.o stubdata.c` If you need to see the whole compilation line, use `gmake VERBOSE=1`. The full compilation line will print if an error occurs.
gmake check
will run the test suite, which checks for ICU's functionality integrity (See [testing note](#running-the-tests-from-the-command-line) below).
gmake install
to install ICU. If you used the `--prefix=` option on `configure` or `runConfigureICU`, ICU will be installed to the directory you specified. (See [installation note](#installing-icu) below).
Type "./runConfigureICU --help" for help on how to run it and a list of supported platforms. You may also want to type "./configure --help" to print the available configure options that you may want to give runConfigureICU. If you are not using the runConfigureICU script, or your platform is not supported by the script, you may need to set your CC, CXX, CFLAGS and CXXFLAGS environment variables, and type "./configure". HP-UX users, please see this note regarding HP-UX multithreaded build issues with newer compilers. Solaris users, please see this note regarding Solaris multithreaded build issues.
ICU is built with strict compiler warnings enabled by default. If this causes excessive numbers of warnings on your platform, use the --disable-strict option to configure to reduce the warning level.
You may have to set certain variables if you with to run test programs individually, that is apart from “gmake check”. The environment variable ICU_DATA can be set to the full pathname of the data directory to indicate where the locale data files and conversion mapping tables are when you are not using the shared library (e.g. by using the .dat archive or the individual data files). The trailing “/” is required after the directory name (e.g. $Root/source/data/out/ will work, but the value $Root/source/data/out is not acceptable). You do not need to set ICU_DATA if the complete shared data library is in your library path.
Some platforms use package management tools to control the installation and uninstallation of files on the system, as well as the integrity of the system configuration. You may want to check if ICU can be packaged for your package management tools by looking into the packaging directory. (Please note that if you are using a snapshot of ICU from Git, it is probable that the packaging scripts or related files are not up to date with the contents of ICU at this time, so use them with caution).
You can install ICU on z/OS or OS/390 (the previous name of z/OS), but IBM tests only the z/OS installation. You install ICU in a z/OS UNIX system services file system such as HFS or zFS. On this platform, it is important that you understand a few details:
OS390_XPLINK=1 prior to invoking the make process to produce binaries that are enabled for XPLINK. The XPLINK option, which is available for z/OS 1.2 and later, requires the PTF PQ69418 to build XPLINK enabled binaries.export _CXX_PSYSIX="CEE.SCEELIB(C128N)":"CBC.SCLBSID(IOSTREAM,COMPLEX)"
export _CEE_RUNOPTS="HEAPPOOLS(ON),HEAP(4M,1M,ANY,FREE,0K,4080)"
By default, ICU builds its libraries into the UNIX file system (HFS). In addition, there is a z/OS specific environment variable (OS390BATCH) to build some libraries into the z/OS native file system. This is useful, for example, when your application is externalized via Job Control Language (JCL).
The OS390BATCH environment variable enables non-UNIX support including the batch environment. When OS390BATCH is set, the libicui18n_XX_.dll, libicuuc_XX_.dll, and libicudt_XX_e.dll binaries are built into data sets (the native file system). Turning on OS390BATCH does not turn off the normal z/OS UNIX build. This means that the z/OS UNIX (HFS) DLLs will always be created.
Two additional environment variables indicate the names of the z/OS data sets to use. The LOADMOD environment variable identifies the name of the data set that contains the dynamic link libraries (DLLs) and the LOADEXP environment variable identifies the name of the data set that contains the side decks, which are normally the files with the .x suffix in the UNIX file system.
A data set is roughly equivalent to a UNIX or Windows file. For most kinds of data sets the operating system maintains record boundaries. UNIX and Windows files are byte streams. Two kinds of data sets are PDS and PDSE. Each data set of these two types contains a directory. It is like a UNIX directory. Each “file” is called a “member”. Each member name is limited to eight bytes, normally EBCDIC.
Here is an example of some environment variables that you can set prior to building ICU:
OS390BATCH=1 LOADMOD=_USER_.ICU.LOAD LOADEXP=_USER_.ICU.EXP
The PDS member names for the DLL file names are as follows:
IXMI_XX_IN --> libicui18n_XX_.dll IXMI_XX_UC --> libicuuc_XX_.dll IXMI_XX_DA --> libicudt_XX_e.dll
You should point the LOADMOD environment variable at a partitioned data set extended (PDSE) and point the LOADEXP environment variable at a partitioned data set (PDS). The PDSE can be allocated with the following attributes:
Data Set Name . . . : USER.ICU.LOAD Management class. . : **None** Storage class . . . : BASE Volume serial . . . : TSO007 Device type . . . . : 3390 Data class. . . . . : LOAD Organization . . . : PO Record format . . . : U Record length . . . : 0 Block size . . . . : 32760 1st extent cylinders: 1 Secondary cylinders : 5 Data set name type : LIBRARY
The PDS can be allocated with the following attributes:
Data Set Name . . . : USER.ICU.EXP Management class. . : **None** Storage class . . . : BASE Volume serial . . . : TSO007 Device type . . . . : 3390 Data class. . . . . : **None** Organization . . . : PO Record format . . . : FB Record length . . . : 80 Block size . . . . : 3200 1st extent cylinders: 3 Secondary cylinders : 3 Data set name type : PDS
Before you start building ICU, ICU requires the following:
The following describes how to setup and build ICU. For background information, you should look at the UNIX build instructions.
CRTLIB LIB(_libraryname_)
ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('_libraryname_') REPLACE(*YES)
ADDENVVAR ENVVAR(MAKE) VALUE('gmake') REPLACE(*YES)
CHGJOB CCSID(37)
qsh
export PATH=/QIBM/ProdData/DeveloperTools/qsh/bin:$PATH:/QOpenSys/usr/bin
gzip -d icu-_X_._Y_.tgz
unpax-icu.sh icu.tar
cd icu/as_is/os400 qsh bldiculd.sh cd ../../..
cd icu/source ./runConfigureICU IBMi --prefix=_/path/to/somewhere_ --with-data-packaging=archive
:point_right: Note: Do not use the -j option
gmake
gmake check
(The QIBM_MULTI_THREADED=Y flag will be automatically applied to intltest - you can look at the iSeries Information Center for more details regarding the running of multiple threads on IBM i.)
This section will explain how to build ICU on one platform, but to produce binaries intended to run on another. This is commonly known as a cross compile.
Normally, in the course of a build, ICU needs to run the tools that it builds in order to generate and package data and test-data. In a cross compilation setting, ICU is built on a different system from that which it eventually runs on. An example might be, if you are building for a small/headless system (such as an embedded device), or a system where you can't easily run the ICU command line tools (any non-UNIX-like system).
To reduce confusion, we will here refer to the “A” and the “B” system. System “A” is the actual system we will be running on - the only requirements on it is are it is able to build ICU from the command line targetting itself (with configure or runConfigureICU), and secondly, that it also contain the correct toolchain for compiling and linking for the resultant platform, referred to as the “B” system.
The autoconf docs use the term “build” for A, and “host” for B. More details at: http://www.gnu.org/software/autoconf/manual/html_node/Specifying-Names.html
Three initially-empty directories will be used in this example:
| /icu | a copy of the ICU source | | /buildA | an empty directory, it will contain ICU built for A (MacOSX in this case) | | /buildB | an empty directory, it will contain ICU built for B (HaikuOS in this case) |
/icu directory.You will have the directories /icu/source, etc./buildA normally (using runConfigureICU or configure):cd /buildA sh /icu/source/runConfigureICU MacOSX gnumake
PATH or other variables as needed, such as CPPFLAGS./buildBcd /buildB sh /icu/source/configure --host=i586-pc-haiku--with-cross-build=/buildA gnumake
:point_right: Note:
--with-cross-buildtakes an absolute path.
gnumake tests.Copyright © 2016 and later: Unicode, Inc. and others. License & terms of use: http://www.unicode.org/copyright.html Copyright © 1997-2016 International Business Machines Corporation and others. All Rights Reserved.