# International Components for Unicode
ICU 2.2 ReadMe

Version: 2002-Aug-15
Copyright © 1997-2002 International Business Machines Corporation and others. All Rights Reserved.

## Table of Contents

## Introduction

Today's software market is a global one in which it is desirable to develop and maintain one application (single source/single binary) that supports a wide variety of languages. The International Components for Unicode (C/C++) provides tools to help write platform-independent applications that are internationalized and localized, with support for:

- Support for the latest version of the Unicode standard
- Character set conversions, with support for over 200 codepages
- Locale data for more than 220 locales
- Text collation (sorting) based on the Unicode Collation Algorithm (=ISO 14651), customizable and tailored for national standards
- Transliteration services for script<->script transliterations and general text operations
- Resource bundles for storing and accessing localized information
- Date/Number/Message formatting and parsing of culture-specific input/output formats
- Text boundary analysis for finding characters, word and sentence boundaries

ICU has a sister project ICU4J that extends the internationalization capabilities of Java to a level similar to ICU. The ICU C/C++ project is also called ICU4C when a distinction is necessary.

## Getting started

This document describes how to build and install ICU on your machine. For other information about ICU please see the following table of links.
The ICU homepage also links to related information about writing internationalized software.

Here are some useful links regarding ICU and internationalization in general.
ICU Homepage | http://oss.software.ibm.com/icu/
ICU4J Homepage | http://oss.software.ibm.com/icu4j/
FAQ - Frequently Asked Questions about ICU | http://oss.software.ibm.com/icu/userguide/icufaq.html
ICU User's Guide | http://oss.software.ibm.com/icu/userguide/
Download ICU Releases | http://oss.software.ibm.com/icu/download/
API Documentation Online | http://oss.software.ibm.com/icu/apiref/
Online ICU Demos | http://oss.software.ibm.com/icu/demo/
Contacts and Bug Reports/Feature Requests | http://oss.software.ibm.com/icu/archives/

Important: Please make sure you understand the Copyright and License Information.

## What is new in this release?

The following list concentrates on changes that affect existing applications migrating from previous ICU releases. For more news about this release, see the ICU 2.2 download page.

### Support for Unicode 3.2

Unicode properties and algorithms have been upgraded to Unicode 3.2, which includes the addition of more than 1000 new encoded characters. The UCA (Unicode Collation Algorithm) table is updated to the current version 3.1.1, with Unicode 3.2-based canonical closure. All Unicode properties (except for those in Unihan.txt) are now available via direct APIs, and most via UnicodeSet.

### Additional and modified converters

New converter implementations are added for:

- UTF-16 and UTF-32 (detect/emit BOM according to IANA registration)
  These and related names used to be aliases for UTF16_PlatformEndian and UTF32_PlatformEndian but are now separate, IANA-registration-compliant converters that detect and emit the respective Byte Order Mark. The "platform endian" converters (without automatic BOM handling) are now only available via their specific names.
- CESU-8 (while the UTF-8 code is tightened according to Unicode 3.2)
- BOCU-1 (MIME-compatible compression of Unicode text that preserves binary order)

### Flexible data loading

ICU 2.2 has an extended search path functionality, more flexible data override capabilities, and removes lesser-known heuristics for determining the data path.

- Performance: ICU will only load data from packages, not from single files, when the search path is empty. This eliminates all file system accesses after the packages (ICU data + application data) are loaded.
  If this is important, then an application should set the search path to the empty path during initialization.
- Customizability: If the search path is not empty, then ICU searches for single files before looking in packages, allowing to override/update packaged data.
- User data: The new function ucnv_openPackage allows an application to load an ICU character mapping table from its own data. This enables applications to support more codepages than the ICU installation that it uses.
- Separation between ICU data and user data: Single data files must now always have a package name as prefix, which results in different file names between ICU and all application packages even for the same locale IDs etc.
- Multi-path: The search path can now contain multiple folders and can list packages directly instead of just a single folder.
- Predictability: The search path can be set via the ICU_DATA environment variable or via the u_setDataDirectory() function.
  ICU does not perform any other heuristics any more.

Note: while some of the old binary data may be still readable by ICU 2.2 (resource bundles, for example), they need to be repackaged in order to be used.

- If you have individual binary files, you have to rename them so that you prepend a `'packagename_'`. Then use `packagename` for opening.
- If you have a memory-mapped package file, you will need to unpack it (use decmn tool), rename individual files as above (prepending the package name), and repack the files.
- If you have a shared library file, you'll need to somehow get individual files and repackage them.

### Customizable memory management

ICU 2.2 libraries do not use the global operators new and delete. Instead, all C++ classes are derived from a common base class UObject which implements new and delete operators for all of ICU's C++ classes. Users can customize the ICU memory allocation by changing the functions in source/common/cmemory.c that are used for non-class types and in UObject's new and delete operators.

This also means that ICU libraries may safely use a different heap than the application because all memory is consistently allocated and released from within the libraries. On Windows it is now possible to link the application with, for example, the static C runtime library even though ICU libraries use the DLL-based runtime.

### Experimental locales moved to new repository

Experimental locales are ones for which we have incomplete data. Data for such locales used to be included in the default ICU download, but have been moved to a new locale data repository, stored as another ICU CVS module. This data can be added back into a customized ICU build, see the User Guide Data chapter. It can also still be viewed with the LocaleExplorer demo.

## How To Download the Source Code

There are two ways to download ICU releases:

- Official Release Snapshot:
  If you want to use ICU (as opposed to developing it), you should download an official packaged version of the ICU source code. These versions are tested more thoroughly than day-to-day development builds of the system, and they are packaged in zip and tar files for convenient download. These packaged files can be found at http://oss.software.ibm.com/icu/download/.
  The packaged snapshots are named icu-nnnn.zip or icu-nnnn.tgz, where nnnn is the version number. The .zip file is used for Windows platforms, while the .tgz file is preferred on most other platforms.
  Please unzip this file. It will reconstruct the source directory, which includes anonymous CVS control directories (see below).
- CVS Source Repository:
  If you are interested in developing features, patches, or bug fixes for ICU, you should probably be working with the latest version of the ICU source code. You will need to check the code out of our CVS repository to ensure that you have the most recent version of all of the files. See our CVS page for details.

## ICU Source Code Organization

In the descriptions below, <ICU> is the full path name of the icu directory (the top level directory from the distribution archives) in your file system. You can also view the User's Guide to see which libraries you need for your software product. You need at least the data (`[lib]icudt`) and the common (`[lib]icuuc`) libraries in order to use ICU.

The following files describe the code drop.
readme.html | Describes the International Components for Unicode (this file)
license.html | Contains the text of the ICU license

The following directories contain source code and data files.
<ICU>/source/common/ | The core Unicode and support functionality, such as resource bundles, character properties, locales, codepage conversion, normalization, Unicode properties, Locale, and UnicodeString.
<ICU>/source/i18n/ | Modules in i18n are generally the more data-driven, that is to say resource bundle driven, components. These deal with higher-level internationalization issues such as formatting, collation, text break analysis, and transliteration.

<ICU>/source/data

This directory contains the source data in text format, which is compiled into binary form during the ICU build process. It contains several subdirectories, in which the data files are grouped by function. Note that the build process must be run again after any changes are made to this directory.

- brkitr/ Data files for character, word, sentence, title casing and line boundary analysis.
- locales/ These .txt files contain ICU language and culture-specific localization data. Two special bundles are root, which is the fallback data and parent of other bundles, and index, which contains a list of installed bundles. The makefile resfiles.mk contains the list of resource bundle files.
- mappings/ Here are the code page converter tables, .ucm files containing mappings to and from Unicode. These are compiled into .cnv files. convrtrs.txt is the alias mapping table from various converter name formats to ICU internal format and vice versa. It produces cnvalias.dat. The makefiles ucmfiles.mk, ucmcore.mk, and ucmebcdic.mk contain the list of converters to be built.
- translit/ This directory contains transliterator rules as resource bundles, a makefile trnsfiles.mk containing the list of installed system translitaration files, and as well the special bundle translit_index which lists the system transliterator aliases.
- unidata/ This directory contains the Unicode data files. Please see http://www.unicode.org/ for more information.
- misc/ The misc directory contains other data files which did not fit into the above categories. Currently it only contains timezone.txt, a generated file, which is compiled into tz.dat. The tz.dat file contains time zone information.
- out/ This directory contains the assembled memory mapped files.
- out/build This directory contains intermediate (compiled) files, such as .cnv, .res, etc.

<ICU>/source/test/intltest/ | A test suite including all C++ APIs. For information about running the test suite, see the users' guide.
<ICU>/source/test/cintltst/ | A test suite written in C, including all C APIs. For information about running the test suite, see the users' guide.

<ICU>/source/test/testdata/

Source text files for data, which are read by the tests. It contains the subdirectories out/build/ which is used for intermediate files, and out/ which contains the files test1.cnv through test4.cnv, and testdata.dat. Note that the tests call u_setDataDirectory("<ICU>/source/test/testdata/lib"), so that ICU will load these files as if they were part of the ICU data package, for testing purposes. This was formerly accomplished by setting the ICU_DATA environment variable to point at these files. ICU_DATA should not be set under normal circumstances.

<ICU>/source/tools | Tools for generating the data files. Data files are generated by invoking <ICU>/source/data/build/makedata.bat on Win32 or <ICU>/source/make on Unix.
<ICU>/source/samples | Various sample programs that use ICU
<ICU>/source/extra | Non-supported API additions. Currently, it contains the 'ustdio' file i/o library
<ICU>/source/layout/ | Contains the ICU layout engine (not a rasterizer).
<ICU>/packaging/ <ICU>/debian/ | These directories contain scripts and tools for packaging the final ICU build for various release platforms.
<ICU>/source/config/ | Contains helper makefiles for platform specific build commands. Used by 'configure'.
<ICU>/source/allinone/ | Contains top-level ICU workspace and project files, for instance to build all of ICU under one MSVC project.
<ICU>/bin/ | Contains the libraries and executables for using ICU on Windows.
<ICU>/include/ | Contains the headers needed for developing software that uses ICU on Windows.

## How To Build And Install ICU

### Supported Platforms

Here is a status of functionality of ICU on several different platforms.
Operating system | Compiler | Testing frequency
--- | --- | ---
Windows NT/2000/XP | Microsoft Visual C++ 6.0 | Reference platform
Red Hat Linux 7.2 | gcc 2.96 | Reference platform
AIX 5.1.0 L | Visual Age C++ 5.0 | Reference platform
Solaris 7 (SunOS 5.7) | Workshop Pro CC 6.0 | Reference platform
HP/UX 11.01 | aCC A.12.10 | Reference platform
Windows 98 | Microsoft Visual C++ 6.0 | Regularly tested
AIX 4.3.3 | xlC_r 3.6.6 | Regularly tested
Solaris 8 (SunOS 5.8) | Workshop Pro CC 4.2 | Regularly tested
Solaris 7 (SunOS 5.7) | Workshop Pro CC 4.2 | Regularly tested
Solaris 2.6 (SunOS 5.6) | gcc 2.95.2 | Regularly tested
FreeBSD 4.4 | gcc 2.95.3 | Regularly tested
Mac OS X (10.1) | gcc-932.1, based on gcc version 2.95.2 (Developer Tools December 2001) | Regularly tested
z/OS 1.2 | cxx 1.2 | Regularly tested
HP/UX 11.01 | CC A.03.10 | Rarely tested
AS/400 (iSeries) V5R1 | iCC | Rarely tested
NetBSD, OpenBSD |  | Rarely tested
SGI/IRIX |  | Rarely tested
Tru64 (OSF) | Compaq's cxx compiler | Rarely tested

Key to testing frequency

Reference platform
  ICU will work on these platforms with these compilers
Regularly tested
  ICU should work on these platforms with these compilers
Rarely tested
  ICU has been ported to these platforms but may not have been tested there recently

### How To Build And Install On Windows

Building International Components for Unicode requires:

- Microsoft NT 4.0 and above, or Windows 98 and above
- Microsoft Visual C++ 6.0 (Service Pack 2 is required to work with the release build of max speed optimization).

(If you want to build with Microsoft Visual C++ .NET, please refer to the note about building with Visual Studio .NET below.)

The steps are:

1. 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.
2. Be sure that the ICU binary directory, <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.
3. Set the TZ environment variable to PST8PDT. The tests will not work in any other time zone.
4. Open the "<ICU>\source\allinone\allinone.dsw" workspace file in Microsoft Visual C++ 6.0. (This workspace includes all the International Components for Unicode libraries, necessary ICU building tools, and the intltest and cintltest test suite projects). Please see the note below if you want to build from the command line instead.
5. Set the active Project to the "all" project. To do this: Choose "Project" menu, and select "Set active project". In the submenu, select the "all" workspace.
6. Set the active configuration to "Win32 Debug" or "Win32 Release" (See note below).
7. Choose the "Build" menu and select "Rebuild All". If you want to build the Debug and Release at the same time, see the note below.
8. Run the C++ test suite, "intltest". To do this: set the active project to "intltest", and press F5 to run it.
9. Run the C test suite, "cintltst". To do this: set the active project to "cintltst", and press F5 to run it.
10. Make sure that both "cintltst" and "intltest" passed without any errors. The return codes are non-zero when they do not pass. Visual C++ will display the return codes in the debug tag of the output window. When "intltest" and "cintltest" return 0, it means that everything is installed correctly. You can press Ctrl+F5 on the test project to run the test and see what error messages were displayed (if any tests failed).
11. Reset the TZ environment variable to its original value, unless you plan on testing ICU any further.
12. 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.

Using MSDEV At The Command Line Note: You can build ICU from the command line. Assuming that you have properly installed Microsoft Visual C++ to support command line execution, you can run the following command, 'msdev <ICU>\source\allinone\allinone.dsw /MAKE "ALL"'.

Setting Active Configuration Note: To set the active configuration, two different possibilities are:

- Choose "Build" menu, select "Set Active Configuration", and select "Win32 Release" or "Win32 Debug".
- Another way is to select "Customize" in the "Tools" menu, select the "Toolbars" tab, enable "Build" instead of "Build Minibar", and click on "Close". This will bring up a toolbar which you can move aside the other permanent toolbars at the top of the MSVC window. The advantage is that you now have an easy-to-reach pop-up menu that will always show the currently selected active configuration. Or, you can drag the project and configuration selections and drop them on the menu bar for later selection.

Batch Configuration Note: If you want to build the Debug and Release configurations at the same time, choose "Build" menu and select "Batch Build..." instead (and mark all configurations as checked), then click the button named "Rebuild All". The "all" workspace will build all the libraries, test programs and various ICU tools (e.g. genrb for generating binary locale data files).

Microsoft Visual Studio .NET Note: ICU will build with Microsoft Visual Studio .NET, though this is not a supported platform at the time of this writing. Visual Studio .NET will offer to convert the project files when you open the existing workspace file. Choose "Yes to All" in the dialog asking whether to convert the files or not (this creates new files) and then follow the rest of the build instructions.

### How To Build And Install On Windows XP on IA64

Building International Components for Unicode requires:

- Microsoft XP on an IA64 (Itanium®) machine
- Microsoft Visual C++ 6.0 (Service Pack 2 is required to work with the release build of max speed optimization).
- Microsoft Platform SDK.

The steps are:

1. Follow steps 1-3 in the in the previous section.
2. Open the "Set Windows XP 64-bit Build Environment (Retail)" command window from the Microsoft Platform SDK.
3. Use cd to get into the <ICU> directory.
4. Run this command: 'msdev /USEENV <ICU>\source\allinone\allinone.dsw /MAKE "all - Win64 Release"'
5. Run "cd source\test\intltest\Release"
6. Run the C++ test suite, "intltest". There should be no errors.
7. Run "cd ..\..\cintltst\Release"
8. Run the C test suite, "cintltst". There should be no errors.
9. Follow the last two steps in the in the previous section.

### How To Build And Install On Unix

Building International Components for Unicode on Unix requires:

- A C++ compiler installed on the target machine (for example: gcc, CC, xlC_r, aCC, cxx, etc...).
- An ANSI C compiler installed on the target machine (for example: cc).
- A recent version of GNU make (3.77+).
- For a list of z/OS tools please view the z/OS build section of this document for further details.

Here are the steps to build ICU:

1. Decompress the icuXXXX.tar (or icuXXXX.tgz) file. For example, `gunzip -d < icuXXXX.tgz | tar xvf -`
2. Change directory to the "icu/source".
3. Run "chmod +x runConfigureICU configure install-sh" because these files may have the wrong permissions.
4. Run the runConfigureICU script for your platform. (See note below).
5. Type "gmake" (or "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".
6. Optionally, type "gmake check" (or "make check") to run the test suite, which checks for ICU's functionality integrity (See note below).
7. Type "gmake install" (or "make install") to install. The install targets support the use of the DESTDIR variable to create the installation tree under a specific destination directory. (See note below).

Configuring ICU NOTE: 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". Some of the more frequently used options to configure are --disable-64bit-libs to create 32-bit libraries, and --srcdir to do out of source builds (build the libraries in the current location).

Running The Tests From The Command Line NOTE: You may have to set certain variables if you with to run test programs individually, that is apart from "make check". The TZ environment variable needs to be set to PST8PDT. Also, 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/" will work, but the value "$Root/source/data" is not acceptable). You do not need to set ICU_DATA if the complete data library is in your library path.

Installing ICU NOTE: If you are using the "gmake install" command, using the "--prefix" option on configure or runConfigureICU will install ICU to the specified location.

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

### z/OS (os/390) Platform

If you are building on the z/OS UNIX System Services platform, it is important that you understand a few details:

- APAR PQ58392 may be needed by z/OS 1.2 in order to get some ICU number formatting functions to work properly.
- The gnu utilities gmake and gzip/gunzip are needed and can be obtained for z/OS from z/OS Unix - Tools and Toys. Documentation on these tools can be found at the Open Source Software for z/OS UNIX Red Book.
- Encoding considerations: The source code assumes that it is compiled with codepage ibm-1047 (to be exact, the UNIX System Services variant of it). The pax command converts all of the source code files from ASCII to codepage ibm-1047 (USS) EBCDIC. However, some files are binary files and must not be converted, or must be converted back to their original state. You can use the unpax-icu.sh script to do this for you automatically. It will unpackage the tar file and convert all the necessary files for you automatically.

- z/OS supports both native S/390 hexadecimal floating point and, (with Version 2.6 and later) IEEE binary floating point. This is a compile time option. Applications built with IEEE should use ICU dlls that are built with IEEE (and vice versa). The environment variable IEEE390=1 will cause the z/OS version of ICU to be built with IEEE floating point. The default is native hexadecimal floating point.
  Important: Currently (ICU 1.4.2), native floating point support is sufficient for codepage conversion, resource bundle and UnicodeString operations, but the Format APIs, especially ChoiceFormat, require IEEE binary floating point.

  Examples for configuring ICU:
  Debug build: `IEEE390=1 ./runConfigureICU --enable-debug zOS/cxx`
  Release build: `IEEE390=1 ./runConfigureICU zOS/cxx`

- Since the default make on z/OS is not gmake, the pkgdata tool requires that the "make" command is aliased to your installed version of gmake. You may also need to set $MAKE equal to the fully-qualified path of GNU make. GNU make is available with the "z/OS Unix - Tools and Toys" that was mentioned above. The required version is the same Unix build instructions.
- The makedep executable that is used with the z/OS ICU build process is not shipped with ICU. It is available at the z/OS Unix - Tools and Toys site. The PATH environment variable should be updated to contain the location of this executable prior to build. Alternatively, makedep may be moved into an existing PATH directory.
- The rest of the instructions for building and testing ICU on z/OS with Unix System Services are the same as the How To Build And Install On Unix section.

#### z/OS Batch (PDS) support

By default, ICU builds its libraries into the HFS. In addition, there is a z/OS specific environment variable 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 batch support. When OS390BATCH is set, the libicuucXX.dll, libicudtXXe.dll, and libicudtXXe_stub.dll binaries are built into the native file system. Turning on OS390BATCH does not turn off the normal HFS build. This means that the 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 HFS.

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 are as follows:

    IXMIXXUC --> libicuucXX.dll
    IXMIXXDA --> libicudtXXe.dll
    IXMIXXD1 --> libicudtXXe_stub.dll (When OS390_STUBDATA=1)

You should point the LOADMOD environment variable at a partitioned data set extended (PDS/E) and point the LOADEXP environment variable at a partitioned data set (PDS). The PDS/E 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

### OS/400 (iSeries) Platform

ICU Reference Release 2.2 contains partial support for the iSeries platform. After building ICU and running the tests, you will notice that some of the multthread and formatting tests fail. The SPAWN CL command will allow the multithread tests in the intltest test suite to run successfully. The formating failures can be ignored for now. These failures are expected to be resolved in a future release of ICU.

The following describes how to setup and build ICU.

- Requirements:
  - QSHELL interpreter installed (install base option 30, operating system)
  - ILE C/C++ Compiler for iSeries, LPP 5722-WDS
  - The latest GNU facilities (You can get the GNU facilities for OS/400 from http://www.as400.ibm.com/developer/porting/gnu_utilities.html). Older versions may not work properly.
- Build environment setup:
  1. Create AS400 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 in step 2.

         CRTLIB LIB(libraryname)

  2. Set up the following environment variables in your build process (use the libraryname from the previous step)

         ADDENVVAR ENVVAR(CC) VALUE('/usr/bin/icc')
         ADDENVVAR ENVVAR(CXX) VALUE('/usr/bin/icc')
         ADDENVVAR ENVVAR(MAKE) VALUE('/usr/bin/gmake')
         ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('libraryname')

     libraryname identifies target as400 library for *module, *pgm and *srvpgm objects.
  3. In order to get the tests to run correctly, the QUTCOFFSET needs to be set to the Pacific Time Zone offset.
     To check your QUTCOFFSET:

         DSPSYSVAL SYSVAL(QUTCOFFSET)

     To change your QUTCOFFSET:

         CHGSYSVAL SYSVAL(QUTCOFFSET) VALUE('-0800')

     You should change -0800 to -0700 for daylight savings.
  4. Run 'CHGJOB CCSID(37)'
  5. Run 'QSH'
  6. Run gunzip on the ICU source code compressed tar archive (icu-X-Y.tar.gz or icu-X-Y.tgz).
  7. Run unpax-icu.sh on the tar file from the ICU download page.
  8. Change your current directory to icu/source.
  9. Run 'cp ../as_is/os400/configure .'
  10. Run './configure --host=as400-os400'
  11. Run 'gmake -e'. The '-e' option is needed to pickup the compilers.
  12. Run 'gmake -e check' to run the tests.

## Important Notes About Using ICU

### Using ICU in a Multithreaded Environment

If you are using ICU in a multithreaded application, there may be a chance that the ICU global mutex is not initialized properly. Normally the ICU global mutex is initialized during C++ static initialization, but there are some compilers and linkers that do not properly perform C++ static initialization in a library (this sometimes happens on HP/UX and on MacOS X).

Upon the first usage of most ICU APIs, the global mutex will get initialized. For example, you could call uloc_countAvailable() or uloc_getDefault() from your main() function before any threads are created. Those functions will initialize the global mutex. Without one of these function calls from a single thread, the data caches inside ICU may get initialized more than once, which may cause memory leaks and other problems. This problem normally does not happen when C++ static initialization works properly.

ICU does not use C++ static initialization for anything else, and disabling threads in ICU will disable all C++ static initialization in ICU.

### Binary Compatibility

Even though the ICU development team tries to make a stable API, some breaking changes are required from time to time. ICU does not guarentee binary compatibility of its functions or its data between releases. Please view the ICU Design chapter of the User's Guide for details.

### Windows Platform

If you are building on the Win32 platform, it is important that you understand a few of the following build details.

#### DLL directories and the PATH setting

As delivered, the International Components for Unicode build as several DLLs, which are placed in the "<ICU>\bin" directory. You must add this directory to the PATH environment variable in your system, or any executables you build will not be able to access International Components for Unicode libraries. Alternatively, you can copy the DLL files into a directory already in your PATH, but we do not recommend this. You can wind up with multiple copies of the DLL and wind up using the wrong one.

#### Changing your PATH

- Windows 2000: Use the System Icon in the Control Panel. Pick the "Advanced" tab. Select the "Environment Variables..." button. Select the variable PATH in the lower box, and select the lower "Edit..." button. In the "Variable Value" box, append the string ";<ICU>\bin" to the end of the path string. If there is nothing there, just type in "<ICU>\bin". Click the Set button, then the OK button.
- Windows NT: Use the System Icon in the Control Panel. Pick the "Environment" tab, and select the variable PATH in the lower box. In the "value" box, append the string ";<ICU>\bin" at the end of the path string. If there is nothing there, just type in "<ICU>\bin". Click the Set button, then the OK button.
- Windows 95/98/ME: Edit the autoexec.bat, and add the following line to the end of file, "SET PATH=%PATH%;<ICU>\bin"

Note: When packaging a Windows application for distribution and installation on user systems, copies of the ICU DLLs should be included with the application, and installed for exclusive use by the application. This is the only way to insure that your app is running with the same version of ICU, built with exactly the same options, that you developed and tested with. Refer to Microsoft's guidelines on the usage of DLLs, or search for the phrase "DLL hell" on msdn.microsoft.com.

#### Linking with Runtime libraries

All the DLLs link with the C runtime library "Debug Multithreaded DLL" or "Multithreaded DLL." (This is changed through the Project Settings dialog, on the C/C++ tab, under Code Generation.) It is important that any executable or other DLL you build which uses the International Components for Unicode DLLs links with these runtime libraries as well. If you do not do this, you will get random memory errors when you run the executable.

### Unix Type Platform

If you are building on a Unix platform, and if you are installing ICU in a non-standard location, you may need to add the location of your ICU libraries to your LD_LIBRARY_PATH or LIBPATH environment variable (or the equivalent runtime library path environment variable for your system). The ICU libraries may not link or load properly without doing this.

Note that if you do not want to have to set this variable, you may instead use the --enable-rpath option at configuration time. This option will instruct the linker to always look for the libraries where they are installed. You will need to use the appropriate linker options when linking your own applications and libraries against ICU, too. Please refer to your system's linker manual for information about runtime paths. The use of rpath also means that when building a new version of ICU you should not have an older version installed in the same place as the new version's installation directory, as the older libraries will used during the build, instead of the new ones, likely leading to an incorrectly build ICU. (This is the proper behavior of rpath.)

### Using the default codepage

ICU has code to determine the default codepage of the system or process. This default codepage can be used to convert `char *` strings to and from Unicode.

Depending on system design, setup and APIs, it may not always be possible to find a default codepage that fully works as expected. For example,

- On Windows there are three encodings in use at the same time. Unicode (UTF-16) is always used inside of Windows, while for `char *` encodings there are two classes, called "ANSI" and "OEM" codepages. ICU will use the ANSI codepage. Note that the OEM codepage is used by default for console window output.
- On some Unix-type systems, non-standard names are used for encodings, or non-standard encodings are used altogether. Although ICU supports 200 encodings in its standard build and many more aliases for them, it will not be able to recognize such non-standard names.
- Some systems do not have a notion of a system or process codepage, and may not have APIs for that.

If you have means of detecting a default codepage name that are more appropriate for your application, then you should set that name with `ucnv_setDefaultName()` as the first ICU function call. This makes sure that the internally cached default converter will be instantiated from your preferred name.

Starting in ICU 2.0, when a converter for the default codepage cannot be opened, a fallback default codepage name and converter will be used. On most platforms, this will be US-ASCII. For z/OS (OS/390), ibm-1047-s390 is the default fallback codepage. For AS/400 (iSeries), ibm-37 is the default fallback codepage. This default fallback codepage is used when the operating system is using a non-standard name for a default codepage, or the converter was not packaged with ICU. The feature allows ICU to run in unusual computing environments without completely failing.

### Methods for enabling deprecated APIs

#### C

Some deprecated C APIs can be enabled without recompiling the ICU libraries. This can be achieved by defining certain symbols before including the ICU header files. For example, to enable deprecated C APIs for formatting.

    #ifndef U_USE_DEPRECATED_FORMAT_API
    #  define U_USE_DEPRECATED_FORMAT_API 1
    #endif

    #include "unicode/udat.h"

    int main(){
        UDateFormat *def, *fr, *fr_pat ;
        UErrorCode status = U_ZERO_ERROR;
        UChar temp[30];

        fr = udat_open(UDAT_FULL, UDAT_DEFAULT, "fr_FR", NULL,0, &status);
        if(U_FAILURE(status)){
            printf("Error creating the french dateformat using full time style\n %s\n",
                myErrorName(status) );
        }
        /* This is supposed to open default date format,
           but later on it treats it like it is "en_US".
           This is very bad when you try to run the tests
           on a machine where the default locale is NOT "en_US"
        */
        def = udat_open(UDAT_SHORT, UDAT_SHORT, "en_US", NULL, 0, &status);
        if(U_FAILURE(status)){
            .... /* handle the error */
        }
    }

#### C++

Deprecated C++ APIs cannot be enabled without recompiling ICU libraries. Every service has a specific symbol that should be defined to enable the deprecated API of that service. For example: To enable deprecated APIs in transliteration service, the U_USE_DEPRECATED_TRANSLITERATOR_API symbol should be defined before compiling ICU.

## Platform Dependencies

The platform dependencies have been mostly isolated into the following files in the common library. This information can be useful if you are porting ICU to a new platform.

- unicode/platform.h.in (autoconf'ed platforms)
  unicode/pXXXX.h (others: pwin32.h, pmacos.h, ..): Platform-dependent typedefs and defines:
  - XP_CPLUSPLUS for C++ only.
  - TRUE and FALSE, UBool, int8_t, int16_t etc.
  - U_EXPORT and U_IMPORT for specifying dynamic library import and export
- unicode/putil.h, putil.c: platform-dependent implementations of various functions that are platform dependent:
  - uprv_isNaN, uprv_isInfinite, uprv_getNaN and uprv_getInfinity for handling special floating point values.
  - uprv_tzset, uprv_timezone, uprv_tzname and time for getting platform specific time and time zone information.
  - u_getDataDirectory for getting the default data directory.
  - uprv_getDefaultLocaleID for getting the default locale setting.
  - uprv_getDefaultCodepage for getting the default codepage encoding.
- umutex.h, umutex.c: Code for doing synchronization in multithreaded applications. If you wish to use International Components for Unicode in a multithreaded application, you must provide a synchronization primitive that the classes can use to protect their global data against simultaneous modifications. See Users' guide for more information.
  - We supply sample implementations for WinNT, Win95, Win98, Sun/Solaris, RedHat/Linux, HP-UX and for AIX on an RS/6000.
- umapfile.h, umapfile.c: functions for mapping or otherwise reading or loading files into memory. All access by ICU to data from files makes use of these functions.
- For the intltest test suite, intltest.cpp in "icu/source/test/intltest/" contains the method pathnameInContext, which must also be adapted to any new platform.
- Using platform specific #ifdef macros are highly discouraged outside of the scope of these files. When the source code gets updated in the future, these #ifdef's can cause testing problems for your platform.

It is possible to build each library individually. They must be built in the following order:

1. stubdata
2. common
3. i18n
4. toolutil
5. makeconv
6. gencnval
7. gennames
8. gennorm
9. genrb
10. genbrk
11. gentz
12. genuca
13. genccode
14. gencmn
15. pkgdata
16. makedata (a project on Windows, or source/data/Makefile on Unix)
17. ctestfw, intltest and cintltst, if you want to run the test suite.
18. uconv and ustdio can also be optionally built.

Copyright © 1997-2002 International Business Machines Corporation and others. All Rights Reserved.
IBM Globalization Center of Competency - San Jose,
5600 Cottle Road, San José, CA 95193
All rights reserved.