A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://unicode-org.github.io/icu/userguide/icu4c/build below:

Building ICU4C | ICU Documentation

Building ICU4C Contents
  1. Recommended Build Options
    1. ICU as a System-Level Library
  2. User-Configurable Settings
  3. How To Build And Install On Windows
    1. Running the Tests from the Windows Command Line (cmd)
    2. Running the Tests from within Visual Studio
    3. Building with other versions of Visual Studio
    4. Re-targeting the Windows 10 SDK for the UWP projects
    5. Using MSBUILD At The Command Line
    6. Skipping the UWP Projects on the Command Line
    7. Setting Active Platform
    8. Setting Active Configuration
    9. Batch Configuration
  4. How To Build And Install On Windows with Cygwin
    1. Configuring ICU on Windows
  5. How To Build And Install On UNIX
    1. Configuring ICU
    2. Running The Tests From The Command Line
    3. Installing ICU
  6. How To Build And Install On z/OS (OS/390)
    1. z/OS (Batch/PDS) support outside the z/OS UNIX environment
  7. How To Build And Install On The IBM i Family (IBM i, i5/OS OS/400)
  8. How To Cross Compile ICU
Recommended Build Options

Depending on the platform and the type of installation, we recommend a small number of modifications and build options. Note that ICU4C requires C11 & C++17.

    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
    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. *   **Hardcode the default charset to UTF-8:** On platforms where the default charset is always UTF-8, like MacOS X and some Linux distributions, we recommend hardcoding ICU's default charset to UTF-8. This means that some implementation code becomes simpler and faster, and statically linked ICU libraries become smaller. (See the [U_CHARSET_IS_UTF8](https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/platform_8h.html#a0a33e1edf3cd23d9e9c972b63c9f7943) API documentation for more details.)
You can `-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

     /*===========================================================================*/
ICU as a System-Level Library

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.

User-Configurable Settings

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.

How To Build And Install On Windows

Building International Components for Unicode requires:

Notes regarding Windows specific issues:

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:

  1. Unzip the icu-XXXX.zip file into any convenient location.
  2. 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.
  3. 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.
  4. 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.
  5. Set the active platform to “Win32” or “x64” (See Windows platform note below) and configuration to “Debug” or “Release” (See Windows configuration note below).
  6. 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.
  7. Run the tests. They can be run from the command line or from within Visual Studio.

    Running the Tests from the Windows Command Line (cmd) Running the Tests from within Visual Studio
    1. Run the C++ test suite, 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.
    2. Run the C test suite, 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.
    3. Run the I/O test suite, 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.
  8. 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.
Building with other versions of Visual Studio

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.

Note: Using older versions of the MSVC compiler is generally not recommended due to the improved support for the C++17 standard in newer versions of the compiler.

Re-targeting the Windows 10 SDK for the UWP projects

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:

Using MSBUILD At The Command Line

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).

Skipping the UWP Projects on the Command Line

You can skip (or omit) building the UWP projects on the command line by passing the argument ‘SkipUWP=true’ to either MSBUILD or devenv.

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.

Setting Active Platform

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:

Setting Active Configuration

To set the active configuration, two different possibilities are:

Batch Configuration

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.

How To Build And Install On Windows with Cygwin

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:

  1. Start the Windows “Command Prompt” window. This is different from the gcc build, which requires the Cygwin Bash command prompt. The Microsoft Visual C++ compiler will not work with a bash command prompt.
  2. If the computer isn’t set up to use Visual C++ from the command line, you need to run vcvars32.bat. For example: 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.
  3. Unzip the icu-XXXX.zip file into any convenient location. Using command line zip, type “unzip -a icu-XXXX.zip -d drive:\directory”, or just use WinZip.
  4. Change directory to “icu/source”, which is where you unzipped ICU.
  5. Run bash ./runConfigureICU Cygwin/MSVC (See Windows configuration note and non-functional configure options below; see source for ./runConfigureICU).
  6. Type make to compile the libraries and all the data files. This make command should be GNU make.
  7. Optionally, type make check to run the test suite, which checks for ICU’s functionality integrity (See testing note below).
  8. Type 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).
Configuring ICU on Windows

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.

How To Build And Install On UNIX

Building International Components for Unicode on UNIX requires:

Here are the steps to build ICU:

  1. Decompress the icu-_X_.Y.tgz (or icu-_X_.Y.tar.gz) file. For example,
    gunzip -d < icu-_X_._Y_.tgz | tar xvf -
    
  2. Change directory to icu/source.
  3. Some files may have the wrong permissions.
    chmod +x runConfigureICU configure install-sh
    
  4. Run the runConfigureICU script for your platform. (See configuration note below).
  5. Now build:

    (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=c11 -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.

  6. Optionally,

    will run the test suite, which checks for ICU’s functionality integrity (See testing note below).

  7. To 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).

Configuring ICU

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.

Running The Tests From The Command Line

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.

Installing ICU

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).

How To Build And Install On z/OS (OS/390)

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 (z/OS UNIX) file system such as HFS or zFS. On this platform, it is important that you understand a few details:

When building ICU data, you might need to set the following environment variables:

export _ENCODE_FILE_NEW=IBM-1047
export _ENCODE_FILE_EXISTING=IBM-1047
export _CEE_RUNOPTS="FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)"
export _BPXK_AUTOCVT=ON
export _TAG_REDIR_ERR=txt
export _TAG_REDIR_IN=txt
export _TAG_REDIR_OUT=txt

The rest of the instructions for building and testing ICU on z/OS UNIX are the same as the How To Build And Install On UNIX section.

z/OS (Batch/PDS) support outside the z/OS UNIX environment

ICU on z/OS builds its libraries into the z/OS UNIX file system (HFS). In addition, some libraries are built with batch-ready names. The default batch-ready ICU naming convention is LICU as prefix, 2 characters for version of ICU library, and 2 characters for specific ICU library name (see examples below). Use the following environmental variables to control z/OS batch-ready build of ICU:

Detailed schema of batch-ready naming:

{ICU_PDS_NAME_PREFIX}{two-character ICU library version}{two-character ICU library code}{ICU_PDS_NAME_SUFFIX}
{                    ICU_PDS_NAME                      }

Default batch-ready library subset names mapped to original UNIX names:

LICU76DA - libicudata.so
LICU76IN - libicui18n.so
LICU76IO - libicuio.so
LICU76UC - libicuuc.so

To use ICU from batch, copy the ICU libraries to a PDSE data set 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
How To Build And Install On The IBM i Family (IBM i, i5/OS OS/400)

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.

  1. Copy the ICU source .tgz to the IBM i environment, as binary. Also, copy the unpax-icu.sh script into the same directory, as a text file.
  2. Create target library. This library will be the target for the resulting modules, programs and service programs. You will specify this library on the OUTPUTDIR environment variable.
    CRTLIB LIB(_libraryname_)
    ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('_libraryname_') REPLACE(*YES)
    
  3. Set up the following environment variables and job characteristics in your build process
    ADDENVVAR ENVVAR(MAKE) VALUE('gmake') REPLACE(*YES)
    CHGJOB CCSID(37)
    
  4. Fire up the QSH (all subsequent commands are run inside the qsh session.)
  5. Set up the PATH:
    export PATH=/QIBM/ProdData/DeveloperTools/qsh/bin:$PATH:/QOpenSys/usr/bin
    
  6. Unpack the ICU source code archive:
  7. Run unpax-icu.sh on the tar file generated from the previous step.
  8. Build the program ICULD which ICU will use for linkage.
    cd icu/as_is/os400
    qsh bldiculd.sh
    cd ../../..
    
  9. Change into the ‘source’ directory, and configure ICU. (See configuration note for details). Note that –with-data-packaging=archive and setting the –prefix are recommended, building in default (dll) mode is currently not supported.
    cd icu/source
    ./runConfigureICU IBMi --prefix=_/path/to/somewhere_ --with-data-packaging=archive
    
  10. Build ICU.

    Note: Do not use the -j option

  11. Test ICU.

    (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.)

How To Cross Compile ICU

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 targeting 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 (macOS in this case) /buildB an empty directory, it will contain ICU built for B (HaikuOS in this case)
  1. Check out or unpack the ICU source code into the /icu directory.You will have the directories /icu/source, etc.
  2. Build ICU in /buildA normally (using runConfigureICU or configure):
    cd /buildA
    sh /icu/source/runConfigureICU macOS
    gnumake
    
  3. Set PATH or other variables as needed, such as CPPFLAGS.
  4. Build ICU in /buildB
    cd /buildB
    sh /icu/source/configure --host=i586-pc-haiku--with-cross-build=/buildA
    gnumake
    

    Note: --with-cross-build takes an absolute path.

  5. Tests and testdata can be built with 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.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4