1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
4<html lang="en-US" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
5 <head>
6 <title>ReadMe for ICU 55.1 (55rc)</title>
7 <meta name="COPYRIGHT" content=
8 "Copyright (c) 1997-2015 IBM Corporation and others. All Rights Reserved." />
9 <meta name="KEYWORDS" content=
10 "ICU; International Components for Unicode; ICU4C; what's new; readme; read me; introduction; downloads; downloading; building; installation;" />
11 <meta name="DESCRIPTION" content=
12 "The introduction to the International Components for Unicode with instructions on building, installation, usage and other information about ICU." />
13 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
14 <link type="text/css" href="/icu4c.css" rel="stylesheet"/>
15 </head>
16
17<!--
18 classes to use with the "body" -
19 draft - if the release note is itself a draft (May be combined with the other two)
20 rc - if the release note is a release candidate
21 milestone - if the release note is a milestone release
22-->
23
24 <body class="rc">
25 <!--<body class="milestone">-->
26 <p class="only-draft"><b>Note:</b> This is a draft readme.</p>
27
28 <h1>
29 <span class="only-draft">DRAFT</span>
30 International Components for Unicode<br/>
31 <span class="only-rc">Release Candidate</span>
32 <span class="only-milestone">(Milestone Release)</span>
33 <abbr title="International Components for Unicode">ICU</abbr> 55.1 (55rc) ReadMe
34 </h1>
35
36 <!-- Shouldn't need to comment/uncomment this paragraph, just change the body class -->
37 <p class="note only-milestone">This is a development milestone release of ICU
38 This milestone is intended for those wishing to get an early look at new features and API changes.
39 It is not recommended for production use.</p>
40
41 <!-- Shouldn't need to comment/uncomment this paragraph, just change the body class -->
42 <p class="note only-rc">This is a release candidate version of ICU4C.
43 It is not recommended for production use.</p>
44
45 <p>Last updated: 2015-Mar-13<br />
46 Copyright © 1997-2015 International Business Machines Corporation and
47 others. All Rights Reserved.</p>
48 <!-- Remember that there is a copyright at the end too -->
49 <hr/>
50
51 <h2 class="TOC">Table of Contents</h2>
52
53 <ul class="TOC">
54 <li><a href="#Introduction">Introduction</a></li>
55
56 <li><a href="#GettingStarted">Getting Started</a></li>
57
58 <li><a href="#News">What Is New In This release?</a></li>
59
60 <li><a href="#Download">How To Download the Source Code</a></li>
61
62 <li><a href="#SourceCode">ICU Source Code Organization</a></li>
63
64 <li>
65 <a href="#HowToBuild">How To Build And Install ICU</a>
66
67 <ul >
68 <li><a href="#RecBuild">Recommended Build Options</a></li>
69
70 <li><a href="#UserConfig">User-Configurable Settings</a></li>
71
72 <li><a href="#HowToBuildWindows">Windows</a></li>
73
74 <li><a href="#HowToBuildCygwin">Cygwin</a></li>
75
76 <li><a href="#HowToBuildUNIX">UNIX</a></li>
77
78 <li><a href="#HowToBuildZOS">z/OS (os/390)</a></li>
79
80 <li><a href="#HowToBuildOS400">IBM i family (IBM i, i5/OS, OS/400)</a></li>
81
82 <li><a href="#HowToCrossCompileICU">How to Cross Compile ICU</a></li>
83 </ul>
84 </li>
85
86
87 <li><a href="#HowToPackage">How To Package ICU</a></li>
88
89 <li>
90 <a href="#ImportantNotes">Important Notes About Using ICU</a>
91
92 <ul >
93 <li><a href="#ImportantNotesMultithreaded">Using ICU in a Multithreaded
94 Environment</a></li>
95
96 <li><a href="#ImportantNotesWindows">Windows Platform</a></li>
97
98 <li><a href="#ImportantNotesUNIX">UNIX Type Platforms</a></li>
99 </ul>
100 </li>
101
102 <li>
103 <a href="#PlatformDependencies">Platform Dependencies</a>
104
105 <ul >
106 <li><a href="#PlatformDependenciesNew">Porting To A New
107 Platform</a></li>
108
109 <li><a href="#PlatformDependenciesImpl">Platform Dependent
110 Implementations</a></li>
111 </ul>
112 </li>
113 </ul>
114 <hr />
115
116 <h2><a name="Introduction" href="#Introduction" id=
117 "Introduction">Introduction</a></h2>
118
119 <p>Today's software market is a global one in which it is desirable to
120 develop and maintain one application (single source/single binary) that
121 supports a wide variety of languages. The International Components for
122 Unicode (ICU) libraries provide robust and full-featured Unicode services on
123 a wide variety of platforms to help this design goal. The ICU libraries
124 provide support for:</p>
125
126 <ul>
127 <li>The latest version of the Unicode standard</li>
128
129 <li>Character set conversions with support for over 220 codepages</li>
130
131 <li>Locale data for more than 300 locales</li>
132
133 <li>Language sensitive text collation (sorting) and searching based on the
134 Unicode Collation Algorithm (=ISO 14651)</li>
135
136 <li>Regular expression matching and Unicode sets</li>
137
138 <li>Transformations for normalization, upper/lowercase, script
139 transliterations (50+ pairs)</li>
140
141 <li>Resource bundles for storing and accessing localized information</li>
142
143 <li>Date/Number/Message formatting and parsing of culture specific
144 input/output formats</li>
145
146 <li>Calendar specific date and time manipulation</li>
147
148 <li>Complex text layout for Arabic, Hebrew, Indic and Thai</li>
149
150 <li>Text boundary analysis for finding characters, word and sentence
151 boundaries</li>
152 </ul>
153
154 <p>ICU has a sister project ICU4J that extends the internationalization
155 capabilities of Java to a level similar to ICU. The ICU C/C++ project is also
156 called ICU4C when a distinction is necessary.</p>
157
158 <h2><a name="GettingStarted" href="#GettingStarted" id=
159 "GettingStarted">Getting started</a></h2>
160
161 <p>This document describes how to build and install ICU on your machine. For
162 other information about ICU please see the following table of links.<br />
163 The ICU homepage also links to related information about writing
164 internationalized software.</p>
165
166 <table class="docTable" summary="These are some useful links regarding ICU and internationalization in general.">
167 <caption>
168 Here are some useful links regarding ICU and internationalization in
169 general.
170 </caption>
171
172 <tr>
173 <td>ICU, ICU4C & ICU4J Homepage</td>
174
175 <td><a href=
176 "http://icu-project.org/">http://icu-project.org/</a></td>
177 </tr>
178
179 <tr>
180 <td>FAQ - Frequently Asked Questions about ICU</td>
181
182 <td><a href=
183 "http://userguide.icu-project.org/icufaq">http://userguide.icu-project.org/icufaq</a></td>
184 </tr>
185
186 <tr>
187 <td>ICU User's Guide</td>
188
189 <td><a href=
190 "http://userguide.icu-project.org/">http://userguide.icu-project.org/</a></td>
191 </tr>
192
193 <tr>
194 <td>How To Use ICU</td>
195
196 <td><a href="http://userguide.icu-project.org/howtouseicu">http://userguide.icu-project.org/howtouseicu</a></td>
197 </tr>
198
199 <tr>
200 <td>Download ICU Releases</td>
201
202 <td><a href=
203 "http://site.icu-project.org/download">http://site.icu-project.org/download</a></td>
204 </tr>
205
206 <tr>
207 <td>ICU4C API Documentation Online</td>
208
209 <td><a href=
210 "http://icu-project.org/apiref/icu4c/">http://icu-project.org/apiref/icu4c/</a></td>
211 </tr>
212
213 <tr>
214 <td>Online ICU Demos</td>
215
216 <td><a href=
217 "http://demo.icu-project.org/icu-bin/icudemos">http://demo.icu-project.org/icu-bin/icudemos</a></td>
218 </tr>
219
220 <tr>
221 <td>Contacts and Bug Reports/Feature Requests</td>
222
223 <td><a href=
224 "http://site.icu-project.org/contacts">http://site.icu-project.org/contacts</a></td>
225 </tr>
226 </table>
227
228 <p><strong>Important:</strong> Please make sure you understand the <a href=
229 "license.html">Copyright and License Information</a>.</p>
230
231 <h2><a name="News" href="#News" id="News">What is new in this
232 release?</a></h2>
233
234 <h3>API Changes</h3>
235 <p>See the <a href="APIChangeReport.html">API Change Report</a> for a complete
236 list of APIs added, removed, or changed in this release.</p>
237
238 <!-- ICU 55 items -->
239 <h3>Layout Engine: breaking API change</h3>
240 <p>The LayoutEngine (already deprecated) has had the function
241 <tt>LEFontInstance::getFontTable(LETag, size_t &length)</tt>
242 since ICU 52. Its implementation was optional. In ICU 55, this
243 version
244 of <tt>getFontTable</tt> has been made pure virtual, and the
245 version without a length (<tt>getFontTable(LETag)</tt>) has been
246 completely removed. This is a breaking change for users who have
247 not implemented the two-argument <tt>getFontTable()</tt>
248 function in their <tt>LEFontInstance</tt> subclasses.
249 The break is intentional, as the one-argument version cannot be
250 made secure. See <tt>LEFontInstance</tt> api docs for more detail.
251 </p>
252
253 <h3>Deprecations in PluralRules (plurrule.h)</h3>
254 <p>The following PluralRules methods never had an implementation
255 but were inadvertently marked @stable; they have now been
256 deprecated. [#<a href="http://bugs.icu-project.org/trac/ticket/10759">10759</a>]</p>
257 <ul>
258 <li><tt>double icu::PluralRules::getUniqueKeywordValue(const UnicodeString&)</tt></li>
259 <li><tt>int32_t icu::PluralRules::getAllKeywordValues(const UnicodeString&, double*, int32_t, UErrorCode&)</tt></li>
260 </ul>
261
262 <h3>Deprecate uidna.h functions for IDNA2003 support</h3>
263 <p>The IDNA2003 API has been deprecated; use the API for IDNA2008 / UTS #46 instead via
264 uidna_openUTS46() or class IDNA [#<a href="http://bugs.icu-project.org/trac/ticket/v">8477</a>].
265 This applies to the following:</p>
266 <ul>
267 <li><tt>enum value UIDNA_ALLOW_UNASSIGNED</tt></li>
268 <li><tt>uidna_IDNToASCII</tt></li>
269 <li><tt>uidna_IDNToUnicode</tt></li>
270 <li><tt>uidna_compare</tt></li>
271 <li><tt>uidna_toASCII</tt></li>
272 <li><tt>uidna_toUnicode</tt></li>
273 </ul>
274
275 <!-- ICU 54 items -->
276 <h3>Deprecation (in ICU 54): Layout Engine</h3>
277 <p>The LayoutEngine is now deprecated. Please
278 see <a href='http://userguide.icu-project.org/layoutengine'>the
279 User's Guide</a> for more details and migration recommendations.
280 In the future, passing "<tt>--enable-layout</tt>" to configure
281 will be required to
282 enable the layout engine.</p>
283 <p>
284 Note that the ParagraphLayout (layoutex) library is not deprecated.
285 There is a new option, <tt>--enable-layoutex</tt> which will build
286 the ParagraphLayout library using <a href="http://harfbuzz.org">HarfBuzz</a>
287 instead of ICU as the layout engine. See <a href="http://userguide.icu-project.org/layoutengine">
288 the users' guide</a> for more information about how to build.
289 </p>
290 <h3>Deprecation (in ICU 54): Collation Short Strings</h3>
291 <p>The collation short naming scheme and its API functions are deprecated.
292 Use ucol_open() with language tag collation keywords instead (see <a href="http://userguide.icu-project.org/collation/api">Collation API Details</a>). For example, <code>ucol_open("de-u-co-phonebk-ka-shifted", &errorCode)</code>
293 for German Phonebook order with "ignore punctuation" mode.</p>
294
295 <h3>Deprecation (in ICU 54): UCOL_TAILORINGS_VERSION</h3>
296 <p>This was originally intended to be the version of collation tailorings,
297 but that information is actually in the tailorings data and this
298 constant has always been (and now will continue to be) 1.</p>
299
300 <h3>Deprecation (in ICU 53): TimeUnitFormat</h3>
301 <p>The TimeUnitFormat and its methods were actually deprecated in ICU 53 and the
302 class as a whole was tagged as deprecated in that release, but the status tags for
303 the individual methods did not correctly indicate the deprecated status; they
304 do as of ICU 54. Use the MeasureFormat class and its methods instead.</p>
305
306 <!-- standing item -->
307 <h3>Full release notes and the latest updates</h3>
308 <p>The previous list concentrates on <em>changes that affect existing
309 applications migrating from previous ICU releases</em>.
310 For more news about this release, as well as late-breaking news, see the
311 <a href="http://site.icu-project.org/download/54">ICU download page</a>.</p>
312
313 <!-- end ICU 54 items -->
314
315 <h2><a name="Download" href="#Download" id="Download">How To Download the
316 Source Code</a></h2>
317
318 <p>There are two ways to download ICU releases:</p>
319
320 <ul>
321 <li><strong>Official Release Snapshot:</strong><br />
322 If you want to use ICU (as opposed to developing it), you should download
323 an official packaged version of the ICU source code. These versions are
324 tested more thoroughly than day-to-day development builds of the system,
325 and they are packaged in zip and tar files for convenient download. These
326 packaged files can be found at <a href=
327 "http://site.icu-project.org/download">http://site.icu-project.org/download</a>.<br />
328 The packaged snapshots are named <strong>icu-nnnn.zip</strong> or
329 <strong>icu-nnnn.tgz</strong>, where nnnn is the version number. The .zip
330 file is used for Windows platforms, while the .tgz file is preferred on
331 most other platforms.<br />
332 Please unzip this file. </li>
333
334 <li><strong>Subversion Source Repository:</strong><br />
335 If you are interested in developing features, patches, or bug fixes for
336 ICU, you should probably be working with the latest version of the ICU
337 source code. You will need to check the code out of our Subversion repository to
338 ensure that you have the most recent version of all of the files. See our
339 <a href="http://site.icu-project.org/repository">source
340 repository</a> for details.</li>
341 </ul>
342
343 <h2><a name="SourceCode" href="#SourceCode" id="SourceCode">ICU Source Code
344 Organization</a></h2>
345
346 <p>In the descriptions below, <strong><i><ICU></i></strong> is the full
347 path name of the ICU directory (the top level directory from the distribution
348 archives) in your file system. You can also view the <a href=
349 "http://userguide.icu-project.org/design">ICU Architectural
350 Design</a> section of the User's Guide to see which libraries you need for
351 your software product. You need at least the data (<code>[lib]icudt</code>)
352 and the common (<code>[lib]icuuc</code>) libraries in order to use ICU.</p>
353
354 <table class="docTable" summary="The following files describe the code drop.">
355 <caption>
356 The following files describe the code drop.
357 </caption>
358
359 <tr>
360 <th scope="col">File</th>
361
362 <th scope="col">Description</th>
363 </tr>
364
365 <tr>
366 <td>readme.html</td>
367
368 <td>Describes the International Components for Unicode (this file)</td>
369 </tr>
370
371 <tr>
372 <td>license.html</td>
373
374 <td>Contains the text of the ICU license</td>
375 </tr>
376 </table>
377
378 <p><br />
379 </p>
380
381 <table class="docTable" summary=
382 "The following directories contain source code and data files.">
383 <caption>
384 The following directories contain source code and data files.
385 </caption>
386
387 <tr>
388 <th scope="col">Directory</th>
389
390 <th scope="col">Description</th>
391 </tr>
392
393 <tr>
394 <td><i><ICU></i>/source/<b>common</b>/</td>
395
396 <td>The core Unicode and support functionality, such as resource bundles,
397 character properties, locales, codepage conversion, normalization,
398 Unicode properties, Locale, and UnicodeString.</td>
399 </tr>
400
401 <tr>
402 <td><i><ICU></i>/source/<b>i18n</b>/</td>
403
404 <td>Modules in i18n are generally the more data-driven, that is to say
405 resource bundle driven, components. These deal with higher-level
406 internationalization issues such as formatting, collation, text break
407 analysis, and transliteration.</td>
408 </tr>
409
410 <tr>
411 <td><i><ICU></i>/source/<b>layout</b>/</td>
412
413 <td>Contains the ICU complex text layout engine. (Deprecated)</td>
414 </tr>
415 <tr>
416 <td><i><ICU></i>/source/<b>layoutex</b>/</td>
417
418 <td>Contains the ICU paragraph layout engine.</td>
419 </tr>
420
421 <tr>
422 <td><i><ICU></i>/source/<b>io</b>/</td>
423
424 <td>Contains the ICU I/O library.</td>
425 </tr>
426
427 <tr>
428 <td><i><ICU></i>/source/<b>data</b>/</td>
429
430 <td>
431 <p>This directory contains the source data in text format, which is
432 compiled into binary form during the ICU build process. It contains
433 several subdirectories, in which the data files are grouped by
434 function. Note that the build process must be run again after any
435 changes are made to this directory.</p>
436
437 <p>If some of the following directories are missing, it's probably
438 because you got an official download. If you need the data source files
439 for customization, then please download the ICU source code from <a
440 href="http://site.icu-project.org/repository">subversion</a>.</p>
441
442 <ul>
443 <li><b>in/</b> A directory that contains a pre-built data library for
444 ICU. A standard source code package will contain this file without
445 several of the following directories. This is to simplify the build
446 process for the majority of users and to reduce platform porting
447 issues.</li>
448
449 <li><b>brkitr/</b> Data files for character, word, sentence, title
450 casing and line boundary analysis.</li>
451
452 <li><b>locales/</b> These .txt files contain ICU language and
453 culture-specific localization data. Two special bundles are
454 <b>root</b>, which is the fallback data and parent of other bundles,
455 and <b>index</b>, which contains a list of installed bundles. The
456 makefile <b>resfiles.mk</b> contains the list of resource bundle
457 files.</li>
458
459 <li><b>mappings/</b> Here are the code page converter tables. These
460 .ucm files contain mappings to and from Unicode. These are compiled
461 into .cnv files. <b>convrtrs.txt</b> is the alias mapping table from
462 various converter name formats to ICU internal format and vice versa.
463 It produces cnvalias.icu. The makefiles <b>ucmfiles.mk,
464 ucmcore.mk,</b> and <b>ucmebcdic.mk</b> contain the list of
465 converters to be built.</li>
466
467 <li><b>translit/</b> This directory contains transliterator rules as
468 resource bundles, a makefile <b>trnsfiles.mk</b> containing the list
469 of installed system translitaration files, and as well the special
470 bundle <b>translit_index</b> which lists the system transliterator
471 aliases.</li>
472
473 <li><b>unidata/</b> This directory contains the Unicode data files.
474 Please see <a href=
475 "http://www.unicode.org/">http://www.unicode.org/</a> for more
476 information.</li>
477
478 <li><b>misc/</b> The misc directory contains other data files which
479 did not fit into the above categories. Currently it only contains
480 time zone information, and a name preperation file for <a href=
481 "http://www.ietf.org/rfc/rfc3490.txt">IDNA</a>.</li>
482
483 <li><b>out/</b> This directory contains the assembled memory mapped
484 files.</li>
485
486 <li><b>out/build/</b> This directory contains intermediate (compiled)
487 files, such as .cnv, .res, etc.</li>
488 </ul>
489
490 <p>If you are creating a special ICU build, you can set the ICU_DATA
491 environment variable to the out/ or the out/build/ directories, but
492 this is generally discouraged because most people set it incorrectly.
493 You can view the <a href=
494 "http://userguide.icu-project.org/icudata">ICU Data
495 Management</a> section of the ICU User's Guide for details.</p>
496 </td>
497 </tr>
498
499 <tr>
500 <td><i><ICU></i>/source/test/<b>intltest</b>/</td>
501
502 <td>A test suite including all C++ APIs. For information about running
503 the test suite, see the build instructions specific to your platform
504 later in this document.</td>
505 </tr>
506
507 <tr>
508 <td><i><ICU></i>/source/test/<b>cintltst</b>/</td>
509
510 <td>A test suite written in C, including all C APIs. For information
511 about running the test suite, see the build instructions specific to your
512 platform later in this document.</td>
513 </tr>
514
515 <tr>
516 <td><i><ICU></i>/source/test/<b>iotest</b>/</td>
517
518 <td>A test suite written in C and C++ to test the icuio library. For
519 information about running the test suite, see the build instructions
520 specific to your platform later in this document.</td>
521 </tr>
522
523 <tr>
524 <td><i><ICU></i>/source/test/<b>testdata</b>/</td>
525
526 <td>Source text files for data, which are read by the tests. It contains
527 the subdirectories <b>out/build/</b> which is used for intermediate
528 files, and <b>out/</b> which contains <b>testdata.dat.</b></td>
529 </tr>
530
531 <tr>
532 <td><i><ICU></i>/source/<b>tools</b>/</td>
533
534 <td>Tools for generating the data files. Data files are generated by
535 invoking <i><ICU></i>/source/data/build/makedata.bat on Win32 or
536 <i><ICU></i>/source/make on UNIX.</td>
537 </tr>
538
539 <tr>
540 <td><i><ICU></i>/source/<b>samples</b>/</td>
541
542 <td>Various sample programs that use ICU</td>
543 </tr>
544
545 <tr>
546 <td><i><ICU></i>/source/<b>extra</b>/</td>
547
548 <td>Non-supported API additions. Currently, it contains the 'uconv' tool
549 to perform codepage conversion on files.</td>
550 </tr>
551
552 <tr>
553 <td><i><ICU></i>/<b>packaging</b>/</td>
554
555 <td>This directory contain scripts and tools for packaging the final
556 ICU build for various release platforms.</td>
557 </tr>
558
559 <tr>
560 <td><i><ICU></i>/source/<b>config</b>/</td>
561
562 <td>Contains helper makefiles for platform specific build commands. Used
563 by 'configure'.</td>
564 </tr>
565
566 <tr>
567 <td><i><ICU></i>/source/<b>allinone</b>/</td>
568
569 <td>Contains top-level ICU workspace and project files, for instance to
570 build all of ICU under one MSVC project.</td>
571 </tr>
572
573 <tr>
574 <td><i><ICU></i>/<b>include</b>/</td>
575
576 <td>Contains the headers needed for developing software that uses ICU on
577 Windows.</td>
578 </tr>
579
580 <tr>
581 <td><i><ICU></i>/<b>lib</b>/</td>
582
583 <td>Contains the import libraries for linking ICU into your Windows
584 application.</td>
585 </tr>
586
587 <tr>
588 <td><i><ICU></i>/<b>bin</b>/</td>
589
590 <td>Contains the libraries and executables for using ICU on Windows.</td>
591 </tr>
592 </table>
593 <!-- end of ICU structure ==================================== -->
594
595 <h2><a name="HowToBuild" href="#HowToBuild" id="HowToBuild">How To Build And
596 Install ICU</a></h2>
597
598 <h3><a name="RecBuild" href="#RecBuild" id=
599 "RecBuild">Recommended Build Options</a></h3>
600
601 <p>Depending on the platform and the type of installation,
602 we recommend a small number of modifications and build options.
603 Note that C99 compatibility is now required.</p>
604 <ul>
605 <li><b>Namespace:</b> By default, unicode/uversion.h has
606 "using namespace icu;" which defeats much of the purpose of the namespace.
607 (This is for historical reasons: Originally, ICU4C did not use namespaces,
608 and some compilers did not support them. The default "using" statement
609 preserves source code compatibility.)<br />
610 If this compatibility is not an issue, we recommend you turn this off
611 via <code>-DU_USING_ICU_NAMESPACE=0</code>
612 or by modifying unicode/uversion.h:
613<pre>Index: source/common/unicode/uversion.h
614===================================================================
615--- source/common/unicode/uversion.h (revision 26606)
616+++ source/common/unicode/uversion.h (working copy)
617@@ -180,7 +180,8 @@
618 # define U_NAMESPACE_QUALIFIER U_ICU_NAMESPACE::
619
620 # ifndef U_USING_ICU_NAMESPACE
621-# define U_USING_ICU_NAMESPACE 1
622+ // Set to 0 to force namespace declarations in ICU usage.
623+# define U_USING_ICU_NAMESPACE 0
624 # endif
625 # if U_USING_ICU_NAMESPACE
626 U_NAMESPACE_USE
627</pre>
628 ICU call sites then either qualify ICU types explicitly,
629 for example <code>icu::UnicodeString</code>,
630 or do <code>using icu::UnicodeString;</code> where appropriate.</li>
631 <li><b>Hardcode the default charset to UTF-8:</b> On platforms where
632 the default charset is always UTF-8,
633 like MacOS X and some Linux distributions,
634 we recommend hardcoding ICU's default charset to UTF-8.
635 This means that some implementation code becomes simpler and faster,
636 and statically linked ICU libraries become smaller.
637 (See the <a href="http://icu-project.org/apiref/icu4c/utypes_8h.html#0a33e1edf3cd23d9e9c972b63c9f7943">U_CHARSET_IS_UTF8</a>
638 API documentation for more details.)<br />
639 You can <code>-DU_CHARSET_IS_UTF8=1</code> or
640 modify unicode/utypes.h (in ICU 4.8 and below)
641 or modify unicode/platform.h (in ICU 49 and higher):
642<pre>Index: source/common/unicode/utypes.h
643===================================================================
644--- source/common/unicode/utypes.h (revision 26606)
645+++ source/common/unicode/utypes.h (working copy)
646@@ -160,7 +160,7 @@
647 * @see UCONFIG_NO_CONVERSION
648 */
649 #ifndef U_CHARSET_IS_UTF8
650-# define U_CHARSET_IS_UTF8 0
651+# define U_CHARSET_IS_UTF8 1
652 #endif
653
654 /*===========================================================================*/
655</pre></li>
656 <li><b>UnicodeString constructors:</b> The UnicodeString class has
657 several single-argument constructors that are not marked "explicit"
658 for historical reasons.
659 This can lead to inadvertent construction of a <code>UnicodeString</code>
660 with a single character by using an integer,
661 and it can lead to inadvertent dependency on the conversion framework
662 by using a C string literal.<br />
663 Beginning with ICU 49, you should do the following:
664 <ul>
665 <li>Consider marking the from-<code>UChar</code>
666 and from-<code>UChar32</code> constructors explicit via
667 <code>-DUNISTR_FROM_CHAR_EXPLICIT=explicit</code> or similar.</li>
668 <li>Consider marking the from-<code>const char*</code> and
669 from-<code>const UChar*</code> constructors explicit via
670 <code>-DUNISTR_FROM_STRING_EXPLICIT=explicit</code> or similar.</li>
671 </ul>
672 Note: The ICU test suites cannot be compiled with these settings.
673 </li>
674 <li><b>utf.h, utf8.h, utf16.h, utf_old.h:</b>
675 By default, utypes.h (and thus almost every public ICU header)
676 includes all of these header files.
677 Often, none of them are needed, or only one or two of them.
678 All of utf_old.h is deprecated or obsolete.<br />
679 Beginning with ICU 49,
680 you should define <code>U_NO_DEFAULT_INCLUDE_UTF_HEADERS</code> to 1
681 (via -D or uconfig.h, as above)
682 and include those header files explicitly that you actually need.<br />
683 Note: The ICU test suites cannot be compiled with this setting.</li>
684 <li><b>.dat file:</b> By default, the ICU data is built into
685 a shared library (DLL). This is convenient because it requires no
686 install-time or runtime configuration,
687 but the library is platform-specific and cannot be modified.
688 A .dat package file makes the opposite trade-off:
689 Platform-portable (except for endianness and charset family, which
690 can be changed with the icupkg tool)
691 and modifiable (also with the icupkg tool).
692 If a path is set, then single data files (e.g., .res files)
693 can be copied to that location to provide new locale data
694 or conversion tables etc.<br />
695 The only drawback with a .dat package file is that the application
696 needs to provide ICU with the file system path to the package file
697 (e.g., by calling <code>u_setDataDirectory()</code>)
698 or with a pointer to the data (<code>udata_setCommonData()</code>)
699 before other ICU API calls.
700 This is usually easy if ICU is used from an application where
701 <code>main()</code> takes care of such initialization.
702 It may be hard if ICU is shipped with
703 another shared library (such as the Xerces-C++ XML parser)
704 which does not control <code>main()</code>.<br />
705 See the <a href="http://userguide.icu-project.org/icudata">User Guide ICU Data</a>
706 chapter for more details.<br />
707 If possible, we recommend building the .dat package.
708 Specify <code>--with-data-packaging=archive</code>
709 on the configure command line, as in<br />
710 <code>runConfigureICU Linux --with-data-packaging=archive</code><br />
711 (Read the configure script's output for further instructions.
712 On Windows, the Visual Studio build generates both the .dat package
713 and the data DLL.)<br />
714 Be sure to install and use the tiny stubdata library
715 rather than the large data DLL.</li>
716 <li><b>Static libraries:</b> It may make sense to build the ICU code
717 into static libraries (.a) rather than shared libraries (.so/.dll).
718 Static linking reduces the overall size of the binary by removing
719 code that is never called.<br />
720 Example configure command line:<br />
721 <code>runConfigureICU Linux --enable-static --disable-shared</code></li>
722 <li><b>Out-of-source build:</b> It is usually desirable to keep the ICU
723 source file tree clean and have build output files written to
724 a different location. This is called an "out-of-source build".
725 Simply invoke the configure script from the target location:
726<pre>~/icu$ svn export http://source.icu-project.org/repos/icu/icu/trunk
727~/icu$ mkdir trunk-dev
728~/icu$ cd trunk-dev
729~/icu/trunk-dev$ /trunk/source/runConfigureICU Linux
730~/icu/trunk-dev$ make check</pre><br/>
731 (Note: this example shows a relative path to
732 <code>runConfigureICU</code>. If you experience difficulty,
733 try using an absolute path to <code>runConfigureICU</code>
734 instead.)
735 </li>
736 </ul>
737 <h4>ICU as a System-Level Library</h4>
738 <p>If ICU is installed as a system-level library, there are further
739 opportunities and restrictions to consider.
740 For details, see the <em>Using ICU as an Operating System Level Library</em>
741 section of the <a href="http://userguide.icu-project.org/design">User Guide ICU Architectural Design</a> chapter.</p>
742 <ul>
743 <li><b>Data path:</b> For a system-level library, it is best to load
744 ICU data from the .dat package file because the file system path
745 to the .dat package file can be hardcoded. ICU will automatically set
746 the path to the final install location using U_ICU_DATA_DEFAULT_DIR.
747 Alternatively, you can set <code>-DICU_DATA_DIR=/path/to/icu/data</code>
748 when building the ICU code. (Used by source/common/putil.c.)<br/>
749 Consider also setting <code>-DICU_NO_USER_DATA_OVERRIDE</code>
750 if you do not want the "ICU_DATA" environment variable to be used.
751 (An application can still override the data path via
752 <code>u_setDataDirectory()</code> or
753 <code>udata_setCommonData()</code>.</li>
754 <li><b>Hide draft API:</b> API marked with <code>@draft</code>
755 is new and not yet stable. Applications must not rely on unstable
756 APIs from a system-level library.
757 Define <code>U_HIDE_DRAFT_API</code>, <code>U_HIDE_INTERNAL_API</code>
758 and <code>U_HIDE_SYSTEM_API</code>
759 by modifying unicode/utypes.h before installing it.</li>
760 <li><b>Only C APIs:</b> Applications must not rely on C++ APIs from a
761 system-level library because binary C++ compatibility
762 across library and compiler versions is very hard to achieve.
763 Most ICU C++ APIs are in header files that contain a comment with
764 <code>\brief C++ API</code>.
765 Consider not installing these header files.</li>
766 <li><b>Disable renaming:</b> By default, ICU library entry point names
767 have an ICU version suffix. Turn this off for a system-level installation,
768 to enable upgrading ICU without breaking applications. For example:<br />
769 <code>runConfigureICU Linux --disable-renaming</code><br />
770 The public header files from this configuration must be installed
771 for applications to include and get the correct entry point names.</li>
772 </ul>
773
774 <h3><a name="UserConfig" href="#UserConfig" id="UserConfig">User-Configurable Settings</a></h3>
775 <p>ICU4C can be customized via a number of user-configurable settings.
776 Many of them are controlled by preprocessor macros which are
777 defined in the <code>source/common/unicode/uconfig.h</code> header file.
778 Some turn off parts of ICU, for example conversion or collation,
779 trading off a smaller library for reduced functionality.
780 Other settings are recommended (see previous section)
781 but their default values are set for better source code compatibility.</p>
782
783 <p>In order to change such user-configurable settings, you can
784 either modify the <code>uconfig.h</code> header file by adding
785 a specific <code>#define ...</code> for one or more of the macros
786 before they are first tested,
787 or set the compiler's preprocessor flags (<code>CPPFLAGS</code>) to include
788 an equivalent <code>-D</code> macro definition.</p>
789
790 <h3><a name="HowToBuildWindows" href="#HowToBuildWindows" id=
791 "HowToBuildWindows">How To Build And Install On Windows</a></h3>
792
793 <p>Building International Components for Unicode requires:</p>
794
795 <ul>
796 <li>Microsoft Windows</li>
797
798 <li>Microsoft Visual C++ (see the ICU download page for the currently compatible version)</li>
799 </ul>
800 <p class="note"><a href="#HowToBuildCygwin">Cygwin</a> is required if using a version of MSVC other than the one
801 compatible with the supplied project files or if other compilers are used to build ICU. (e.g. GCC)</p>
802
803 <p>The steps are:</p>
804
805 <ol>
806 <li>Unzip the icu-XXXX.zip file into any convenient location. Using command
807 line zip, type "unzip -a icu-XXXX.zip -d drive:\directory", or just use
808 WinZip.</li>
809
810 <li>Be sure that the ICU binary directory, <i><ICU></i>\bin\, is
811 included in the <strong>PATH</strong> environment variable. The tests will
812 not work without the location of the ICU DLL files in the path.</li>
813
814 <li>Open the "<i><ICU></i>\source\allinone\allinone.sln" workspace
815 file in Microsoft Visual Studio. (This solution includes all the
816 International Components for Unicode libraries, necessary ICU building
817 tools, and the test suite projects). Please see the <a href=
818 "#HowToBuildWindowsCommandLine">command line note below</a> if you want to
819 build from the command line instead.</li>
820
821 <li>Set the active platform to "Win32" or "x64" (See <a href="#HowToBuildWindowsPlatform">Windows platform note</a> below)
822 and configuration to "Debug" or "Release" (See <a href="#HowToBuildWindowsConfig">Windows configuration note</a> below).</li>
823
824 <li>Choose the "Build" menu and select "Rebuild Solution". If you want to
825 build the Debug and Release at the same time, see the <a href=
826 "#HowToBuildWindowsBatch">batch configuration note</a> below.</li>
827
828
829 <li>Run the tests. They can be run from the command line or from within Visual Studio.
830
831 <h4>Running the Tests from the Windows Command Line (cmd)</h4>
832 <ul>
833 <li>For x86 (32 bit) and Debug, use: <br />
834
835 <tt><i><ICU></i>\source\allinone\icucheck.bat <i>Platform</i> <i>Configuration</i>
836 </tt> <br />
837 </li>
838 <li>So, for example:
839 <br />
840 <samp><i><ICU></i>\source\allinone\icucheck.bat <b>x86</b> <b>Debug</b></samp>
841 or
842 <samp><i><ICU></i>\source\allinone\icucheck.bat <b>x86</b> <b>Release</b></samp>
843 or
844 <samp><i><ICU></i>\source\allinone\icucheck.bat <b>x64</b> <b>Release</b></samp></li>
845 </ul>
846
847 <h4>Running the Tests from within Visual Studio</h4>
848
849 <ol>
850 <li>Run the C++ test suite, "intltest". To do this: set the active startup
851 project to "intltest", and press Ctrl+F5 to run it. Make sure that it
852 passes without any errors.</li>
853
854 <li>Run the C test suite, "cintltst". To do this: set the active startup
855 project to "cintltst", and press Ctrl+F5 to run it. Make sure that it
856 passes without any errors.</li>
857
858 <li>Run the I/O test suite, "iotest". To do this: set the active startup
859 project to "iotest", and press Ctrl+F5 to run it. Make sure that it passes
860 without any errors.</li>
861
862 </ol>
863
864 </li>
865
866 <li>You are now able to develop applications with ICU by using the
867 libraries and tools in <i><ICU></i>\bin\. The headers are in
868 <i><ICU></i>\include\ and the link libraries are in
869 <i><ICU></i>\lib\. To install the ICU runtime on a machine, or ship
870 it with your application, copy the needed components from
871 <i><ICU></i>\bin\ to a location on the system PATH or to your
872 application directory.</li>
873 </ol>
874
875 <p><a name="HowToBuildWindowsCommandLine" id=
876 "HowToBuildWindowsCommandLine"><strong>Using MSDEV At The Command Line
877 Note:</strong></a> You can build ICU from the command line. Assuming that you
878 have properly installed Microsoft Visual C++ to support command line
879 execution, you can run the following command, 'devenv.com
880 <i><ICU></i>\source\allinone\allinone.sln /build "Win32|Release"'. You can also
881 use Cygwin with this compiler to build ICU, and you can refer to the <a href=
882 "#HowToBuildCygwin">How To Build And Install On Windows with Cygwin</a>
883 section for more details.</p>
884
885 <p><a name="HowToBuildWindowsPlatform" id=
886 "HowToBuildWindowsPlatform"><strong>Setting Active Platform
887 Note:</strong></a> Even though you are able to select "x64" as the active platform, if your operating system is
888 not a 64 bit version of Windows, the build will fail. To set the active platform, two different possibilities are:</p>
889
890 <ul>
891 <li>Choose "Build" menu, select "Configuration Manager...", and select
892 "Win32" or "x64" for the Active Platform Solution.</li>
893
894 <li>Another way is to select the desired build configuration from "Solution
895 Platforms" dropdown menu from the standard toolbar. It will say
896 "Win32" or "x64" in the dropdown list.</li>
897 </ul>
898
899 <p><a name="HowToBuildWindowsConfig" id=
900 "HowToBuildWindowsConfig"><strong>Setting Active Configuration
901 Note:</strong></a> To set the active configuration, two different
902 possibilities are:</p>
903
904 <ul>
905 <li>Choose "Build" menu, select "Configuration Manager...", and select
906 "Release" or "Debug" for the Active Configuration Solution.</li>
907
908 <li>Another way is to select the desired build configuration from "Solution
909 Configurations" dropdown menu from the standard toolbar. It will say
910 "Release" or "Debug" in the dropdown list.</li>
911 </ul>
912
913 <p><a name="HowToBuildWindowsBatch" id="HowToBuildWindowsBatch"><strong>Batch
914 Configuration Note:</strong></a> If you want to build the Win32 and x64 platforms and
915 Debug and Release configurations at the same time, choose "Build" menu, and select "Batch
916 Build...". Click the "Select All" button, and then click the "Rebuild"
917 button.</p>
918
919 <h3><a name="HowToBuildCygwin" href="#HowToBuildCygwin" id=
920 "HowToBuildCygwin">How To Build And Install On Windows with Cygwin</a></h3>
921
922 <p>Building International Components for Unicode with this configuration
923 requires:</p>
924
925 <ul>
926 <li>Microsoft Windows</li>
927
928 <li>Microsoft Visual C++ (when gcc isn't used).</li>
929
930 <li>
931 Cygwin with the following installed:
932
933 <ul>
934 <li>bash</li>
935
936 <li>GNU make</li>
937
938 <li>ar</li>
939
940 <li>ranlib</li>
941
942 <li>man (if you plan to look at the man pages)</li>
943 </ul>
944 </li>
945 </ul>
946
947 <p>There are two ways you can build ICU with Cygwin. You can build with gcc
948 or Microsoft Visual C++. If you use gcc, the resulting libraries and tools
949 will depend on the Cygwin environment. If you use Microsoft Visual C++, the
950 resulting libraries and tools do not depend on Cygwin and can be more easily
951 distributed to other Windows computers (the generated man pages and shell
952 scripts still need Cygwin). To build with gcc, please follow the "<a href=
953 "#HowToBuildUNIX">How To Build And Install On UNIX</a>" instructions, while
954 you are inside a Cygwin bash shell. To build with Microsoft Visual C++,
955 please use the following instructions:</p>
956
957 <ol>
958 <li>Start the Windows "Command Prompt" window. This is different from the
959 gcc build, which requires the Cygwin Bash command prompt. The Microsoft
960 Visual C++ compiler will not work with a bash command prompt.</li>
961
962 <li>If the computer isn't set up to use Visual C++ from the command line,
963 you need to run vcvars32.bat.<br />For example:<br />"<tt>C:\Program Files\Microsoft
964 Visual Studio 8\VC\bin\vcvars32.bat</tt>" can be used for 32-bit builds
965 <strong>or</strong> <br />"<tt>C:\Program Files (x86)\Microsoft Visual Studio
966 8\VC\bin\amd64\vcvarsamd64.bat</tt>" can be used for 64-bit builds on
967 Windows x64.</li>
968
969 <li>Unzip the icu-XXXX.zip file into any convenient location. Using command
970 line zip, type "unzip -a icu-XXXX.zip -d drive:\directory", or just use
971 WinZip.</li>
972
973 <li>Change directory to "icu/source", which is where you unzipped ICU.</li>
974
975 <li>Run "<tt>bash <a href="source/runConfigureICU">/runConfigureICU</a>
976 Cygwin/MSVC</tt>" (See <a href="#HowToWindowsConfigureICU">Windows
977 configuration note</a> and non-functional configure options below).</li>
978
979 <li>Type <tt>"make"</tt> to compile the libraries and all the data files.
980 This make command should be GNU make.</li>
981
982 <li>Optionally, type <tt>"make check"</tt> to run the test suite, which
983 checks for ICU's functionality integrity (See <a href=
984 "#HowToTestWithoutGmake">testing note</a> below).</li>
985
986 <li>Type <tt>"make install"</tt> to install ICU. If you used the --prefix=
987 option on configure or runConfigureICU, ICU will be installed to the
988 directory you specified. (See <a href="#HowToInstallICU">installation
989 note</a> below).</li>
990 </ol>
991
992 <p><a name="HowToWindowsConfigureICU" id=
993 "HowToWindowsConfigureICU"><strong>Configuring ICU on Windows
994 NOTE:</strong></a> </p>
995 <p>
996 Ensure that the order of the PATH is MSVC, Cygwin, and then other PATHs. The configure
997 script needs certain tools in Cygwin (e.g. grep).
998 </p>
999 <p>
1000 Also, you may need to run <tt>"dos2unix.exe"</tt> on all of the scripts (e.g. configure)
1001 in the top source directory of ICU. To avoid this issue, you can download
1002 the ICU source for Unix platforms (icu-xxx.tgz).
1003 </p>
1004 <p>In addition to the Unix <a href=
1005 "#HowToConfigureICU">configuration note</a> the following configure options
1006 currently do not work on Windows with Microsoft's compiler. Some options can
1007 work by manually editing <tt>icu/source/common/unicode/pwin32.h</tt>, but
1008 manually editing the files is not recommended.</p>
1009
1010 <ul>
1011 <li><tt>--disable-renaming</tt></li>
1012
1013 <li><tt>--enable-tracing</tt></li>
1014
1015 <li><tt>--enable-rpath</tt></li>
1016
1017 <li><tt>--enable-static</tt> (Requires that U_STATIC_IMPLEMENTATION be
1018 defined in user code that links against ICU's static libraries.)</li>
1019
1020 <li><tt>--with-data-packaging=files</tt> (The pkgdata tool currently does
1021 not work in this mode. Manual packaging is required to use this mode.)</li>
1022 </ul>
1023
1024 <h3><a name="HowToBuildUNIX" href="#HowToBuildUNIX" id="HowToBuildUNIX">How
1025 To Build And Install On UNIX</a></h3>
1026
1027 <p>Building International Components for Unicode on UNIX requires:</p>
1028
1029 <ul>
1030 <li>A C++ compiler installed on the target machine (for example: gcc, CC,
1031 xlC_r, aCC, cxx, etc...).</li>
1032
1033 <li>An ANSI C compiler installed on the target machine (for example:
1034 cc).</li>
1035
1036 <li>A recent version of GNU make (3.80+).</li>
1037
1038 <li>For a list of z/OS tools please view the <a href="#HowToBuildZOS">z/OS
1039 build section</a> of this document for further details.</li>
1040 </ul>
1041
1042 <p>Here are the steps to build ICU:</p>
1043
1044 <ol>
1045 <li>Decompress the icu-<i>X</i>.<i>Y</i>.tgz (or
1046 icu-<i>X</i>.<i>Y</i>.tar.gz) file. For example, <samp>gunzip -d < icu-<i>X</i>.<i>Y</i>.tgz | tar xvf -</samp></li>
1047
1048 <li>Change directory to <code>icu/source</code>.
1049 <samp>cd icu/source</samp>
1050 </li>
1051
1052 <li>Some files may have the wrong permissions.<samp>chmod +x runConfigureICU configure install-sh</samp></li>
1053
1054 <li>Run the <span style='font-family: monospace;'><a href="source/runConfigureICU">runConfigureICU</a></span>
1055 script for your platform. (See <a href="#HowToConfigureICU">configuration
1056 note</a> below).</li>
1057
1058 <li>Now build: <samp>gmake</samp> (or just <code>make</code> if GNU make is the default make on
1059 your platform) to compile the libraries and all the data files. The proper
1060 name of the GNU make command is printed at the end of the configuration
1061 run, as in <tt>"You must use gmake to compile ICU"</tt>.
1062 <br/>
1063 Note that the compilation command output may be simplified on your platform. If this is the case, you will see just:
1064 <tt>gcc ... stubdata.c</tt>
1065 rather than
1066 <tt>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</tt>
1067 <br/>
1068 If you need to see the whole compilation line, use <span style='font-family: monospace;'>"gmake VERBOSE=1"</span>. The full compilation line will print if an error occurs.
1069 </li>
1070
1071 <li>Optionally,<samp>gmake check</samp> will run the test suite, which
1072 checks for ICU's functionality integrity (See <a href=
1073 "#HowToTestWithoutGmake">testing note</a> below).</li>
1074
1075 <li>To install, <samp>gmake install</samp> to install ICU. If you used the --prefix=
1076 option on configure or runConfigureICU, ICU will be installed to the
1077 directory you specified. (See <a href="#HowToInstallICU">installation
1078 note</a> below).</li>
1079 </ol>
1080
1081 <p><a name="HowToConfigureICU" id="HowToConfigureICU"><strong>Configuring ICU
1082 NOTE:</strong></a> Type <tt>"/runConfigureICU --help"</tt> for help on how
1083 to run it and a list of supported platforms. You may also want to type
1084 <tt>"/configure --help"</tt> to print the available configure options that
1085 you may want to give runConfigureICU. If you are not using the
1086 runConfigureICU script, or your platform is not supported by the script, you
1087 may need to set your CC, CXX, CFLAGS and CXXFLAGS environment variables, and
1088 type <tt>"/configure"</tt>.
1089 HP-UX users, please see this <a href="#ImportantNotesHPUX">note regarding
1090 HP-UX multithreaded build issues</a> with newer compilers. Solaris users,
1091 please see this <a href="#ImportantNotesSolaris">note regarding Solaris
1092 multithreaded build issues</a>.</p>
1093
1094 <p>ICU is built with strict compiler warnings enabled by default. If this
1095 causes excessive numbers of warnings on your platform, use the --disable-strict
1096 option to configure to reduce the warning level.</p>
1097
1098 <p><a name="HowToTestWithoutGmake" id="HowToTestWithoutGmake"><strong>Running
1099 The Tests From The Command Line NOTE:</strong></a> You may have to set
1100 certain variables if you with to run test programs individually, that is
1101 apart from "gmake check". The environment variable <strong>ICU_DATA</strong>
1102 can be set to the full pathname of the data directory to indicate where the
1103 locale data files and conversion mapping tables are when you are not using
1104 the shared library (e.g. by using the .dat archive or the individual data
1105 files). The trailing "/" is required after the directory name (e.g.
1106 "$Root/source/data/out/" will work, but the value "$Root/source/data/out" is
1107 not acceptable). You do not need to set <strong>ICU_DATA</strong> if the
1108 complete shared data library is in your library path.</p>
1109
1110 <p><a name="HowToInstallICU" id="HowToInstallICU"><strong>Installing ICU
1111 NOTE:</strong></a> Some platforms use package management tools to control the
1112 installation and uninstallation of files on the system, as well as the
1113 integrity of the system configuration. You may want to check if ICU can be
1114 packaged for your package management tools by looking into the "packaging"
1115 directory. (Please note that if you are using a snapshot of ICU from Subversion, it
1116 is probable that the packaging scripts or related files are not up to date
1117 with the contents of ICU at this time, so use them with caution).</p>
1118
1119 <h3><a name="HowToBuildZOS" href="#HowToBuildZOS" id="HowToBuildZOS">How To
1120 Build And Install On z/OS (OS/390)</a></h3>
1121
1122 <p>You can install ICU on z/OS or OS/390 (the previous name of z/OS), but IBM
1123 tests only the z/OS installation. You install ICU in a z/OS UNIX system
1124 services file system such as HFS or zFS. On this platform, it is important
1125 that you understand a few details:</p>
1126
1127 <ul>
1128 <li>The makedep and GNU make tools are required for building ICU. If it
1129 is not already installed on your system, it is available at the <a href=
1130 "http://www-03.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html">z/OS UNIX -
1131 Tools and Toys</a> site. The PATH environment variable should be updated to
1132 contain the location of this executable prior to build. Failure to add these
1133 tools to your PATH will cause ICU build failures or cause pkgdata to fail
1134 to run.</li>
1135
1136 <li>Since USS does not support using the mmap() function over NFS, it is
1137 recommended that you build ICU on a local filesystem. Once ICU has been
1138 built, you should not have this problem while using ICU when the data
1139 library has been built as a shared library, which is this is the default
1140 setting.</li>
1141
1142 <li>Encoding considerations: The source code assumes that it is compiled
1143 with codepage ibm-1047 (to be exact, the UNIX System Services variant of
1144 it). The pax command converts all of the source code files from ASCII to
1145 codepage ibm-1047 (USS) EBCDIC. However, some files are binary files and
1146 must not be converted, or must be converted back to their original state.
1147 You can use the <a href="as_is/os390/unpax-icu.sh">unpax-icu.sh</a> script
1148 to do this for you automatically. It will unpackage the tar file and
1149 convert all the necessary files for you automatically.</li>
1150
1151 <li>z/OS supports both native S/390 hexadecimal floating point and (with
1152 OS/390 2.6 and later) IEEE 754 binary floating point. This is a compile
1153 time option. Applications built with IEEE should use ICU DLLs that are
1154 built with IEEE (and vice versa). The environment variable IEEE390=0 will
1155 cause the z/OS version of ICU to be built without IEEE floating point
1156 support and use the native hexadecimal floating point. By default ICU is
1157 built with IEEE 754 support. Native floating point support is sufficient
1158 for codepage conversion, resource bundle and UnicodeString operations, but
1159 the Format APIs require IEEE binary floating point.</li>
1160
1161 <li>z/OS introduced the concept of Extra Performance Linkage (XPLINK) to
1162 bring performance improvement opportunities to call-intensive C and C++
1163 applications such as ICU. XPLINK is enabled on a DLL-by-DLL basis, so if
1164 you are considering using XPLINK in your application that uses ICU, you
1165 should consider building the XPLINK-enabled version of ICU. You need to
1166 set ICU's environment variable <code>OS390_XPLINK=1</code> prior to
1167 invoking the make process to produce binaries that are enabled for
1168 XPLINK. The XPLINK option, which is available for z/OS 1.2 and later,
1169 requires the PTF PQ69418 to build XPLINK enabled binaries.</li>
1170
1171 <li>ICU requires XPLINK for the icuio library. If you want to use the
1172 rest of ICU without XPLINK, then you must use the --disable-icuio
1173 configure option.</li>
1174
1175 <li>The latest versions of z/OS use <a
1176 href="http://www.ibm.com/support/docview.wss?uid=swg2120240">XPLINK
1177 version (C128) of the C++ standard library</a> by default. You may see <a
1178 href="http://www.ibm.com/support/docview.wss?uid=swg21376279">an
1179 error</a> when running with XPLINK disabled. To avoid this error,
1180 set the following environment variable or similar:
1181
1182<pre><samp>export _CXX_PSYSIX="CEE.SCEELIB(C128N)":"CBC.SCLBSID(IOSTREAM,COMPLEX)"</samp></pre>
1183 </li>
1184
1185 <li>When building ICU data, the heap size may need to be increased with the following
1186 environment variable:
1187
1188<pre><samp>export _CEE_RUNOPTS="HEAPPOOLS(ON),HEAP(4M,1M,ANY,FREE,0K,4080)"</samp></pre>
1189 </li>
1190
1191
1192 <li>The rest of the instructions for building and testing ICU on z/OS with
1193 UNIX System Services are the same as the <a href="#HowToBuildUNIX">How To
1194 Build And Install On UNIX</a> section.</li>
1195 </ul>
1196
1197 <h4>z/OS (Batch/PDS) support outside the UNIX system services
1198 environment</h4>
1199
1200 <p>By default, ICU builds its libraries into the UNIX file system (HFS). In
1201 addition, there is a z/OS specific environment variable (OS390BATCH) to build
1202 some libraries into the z/OS native file system. This is useful, for example,
1203 when your application is externalized via Job Control Language (JCL).</p>
1204
1205 <p>The OS390BATCH environment variable enables non-UNIX support including the
1206 batch environment. When OS390BATCH is set, the libicui18n<i>XX</i>.dll,
1207 libicuuc<i>XX</i>.dll, and libicudt<i>XX</i>e.dll binaries are built into
1208 data sets (the native file system). Turning on OS390BATCH does not turn off
1209 the normal z/OS UNIX build. This means that the z/OS UNIX (HFS) DLLs will
1210 always be created.</p>
1211
1212 <p>Two additional environment variables indicate the names of the z/OS data
1213 sets to use. The LOADMOD environment variable identifies the name of the data
1214 set that contains the dynamic link libraries (DLLs) and the LOADEXP
1215 environment variable identifies the name of the data set that contains the
1216 side decks, which are normally the files with the .x suffix in the UNIX file
1217 system.</p>
1218
1219 <p>A data set is roughly equivalent to a UNIX or Windows file. For most kinds
1220 of data sets the operating system maintains record boundaries. UNIX and
1221 Windows files are byte streams. Two kinds of data sets are PDS and PDSE. Each
1222 data set of these two types contains a directory. It is like a UNIX
1223 directory. Each "file" is called a "member". Each member name is limited to
1224 eight bytes, normally EBCDIC.</p>
1225
1226 <p>Here is an example of some environment variables that you can set prior to
1227 building ICU:</p>
1228<pre>
1229<samp>OS390BATCH=1
1230LOADMOD=<i>USER</i>.ICU.LOAD
1231LOADEXP=<i>USER</i>.ICU.EXP</samp>
1232</pre>
1233
1234 <p>The PDS member names for the DLL file names are as follows:</p>
1235<pre>
1236<samp>IXMI<i>XX</i>IN --> libicui18n<i>XX</i>.dll
1237IXMI<i>XX</i>UC --> libicuuc<i>XX</i>.dll
1238IXMI<i>XX</i>DA --> libicudt<i>XX</i>e.dll</samp>
1239</pre>
1240
1241 <p>You should point the LOADMOD environment variable at a partitioned data
1242 set extended (PDSE) and point the LOADEXP environment variable at a
1243 partitioned data set (PDS). The PDSE can be allocated with the following
1244 attributes:</p>
1245<pre>
1246<samp>Data Set Name . . . : <i>USER</i>.ICU.LOAD
1247Management class. . : <i>**None**</i>
1248Storage class . . . : <i>BASE</i>
1249Volume serial . . . : <i>TSO007</i>
1250Device type . . . . : <i>3390</i>
1251Data class. . . . . : <i>LOAD</i>
1252Organization . . . : PO
1253Record format . . . : U
1254Record length . . . : 0
1255Block size . . . . : <i>32760</i>
12561st extent cylinders: 1
1257Secondary cylinders : 5
1258Data set name type : LIBRARY</samp>
1259</pre>
1260
1261 <p>The PDS can be allocated with the following attributes:</p>
1262<pre>
1263<samp>Data Set Name . . . : <i>USER</i>.ICU.EXP
1264Management class. . : <i>**None**</i>
1265Storage class . . . : <i>BASE</i>
1266Volume serial . . . : <i>TSO007</i>
1267Device type . . . . : <i>3390</i>
1268Data class. . . . . : <i>**None**</i>
1269Organization . . . : PO
1270Record format . . . : FB
1271Record length . . . : 80
1272Block size . . . . : <i>3200</i>
12731st extent cylinders: 3
1274Secondary cylinders : 3
1275Data set name type : PDS</samp>
1276</pre>
1277
1278 <h3><a name="HowToBuildOS400" href="#HowToBuildOS400" id=
1279 "HowToBuildOS400">How To Build And Install On The IBM i Family (IBM i, i5/OS OS/400)</a></h3>
1280
1281 <p>Before you start building ICU, ICU requires the following:</p>
1282
1283 <ul>
1284 <li>QSHELL interpreter installed (install base option 30, operating system)
1285 <!--li>QShell Utilities, PRPQ 5799-XEH (not required for V4R5)</li--></li>
1286
1287 <li>ILE C/C++ Compiler installed on the system</li>
1288
1289 <li>The latest IBM tools for Developers for IBM i —
1290 <a href='http://www.ibm.com/servers/enable/site/porting/tools/'>http://www.ibm.com/servers/enable/site/porting/tools/</a>
1291 <!-- formerly: http://www.ibm.com/servers/enable/site/porting/iseries/overview/gnu_utilities.html -->
1292 </li>
1293 </ul>
1294
1295 <p>The following describes how to setup and build ICU. For background
1296 information, you should look at the <a href="#HowToBuildUNIX">UNIX build
1297 instructions</a>.</p>
1298
1299 <ol>
1300 <li>
1301 Copy the ICU source .tgz to the IBM i environment, as binary.
1302 Also, copy the <a href='as_is/os400/unpax-icu.sh'>unpax-icu.sh</a> script into the same directory, as a text file.
1303 </li>
1304
1305 <li>
1306 Create target library. This library will be the target for the
1307 resulting modules, programs and service programs. You will specify this
1308 library on the OUTPUTDIR environment variable.
1309<pre>
1310<samp>CRTLIB LIB(<i>libraryname</i>)
1311ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('<i>libraryname</i>') REPLACE(*YES) </samp></pre>
1312 </li>
1313
1314 <li>
1315 Set up the following environment variables and job characteristics in your build process
1316<pre>
1317<samp>ADDENVVAR ENVVAR(MAKE) VALUE('gmake') REPLACE(*YES)
1318CHGJOB CCSID(37)</samp></pre></li>
1319
1320 <li>Fire up the QSH <i>(all subsequent commands are run inside the qsh session.)</i>
1321 <pre><samp>qsh</samp></pre>
1322 </li>
1323
1324 <li>Set up the PATH: <pre><samp>export PATH=/QIBM/ProdData/DeveloperTools/qsh/bin:$PATH:/QOpenSys/usr/bin</samp></pre>
1325 </li>
1326
1327 <li>Unpack the ICU source code archive:
1328 <pre><samp>gzip -d icu-<i>X</i>.<i>Y</i>.tgz</samp></pre>
1329 </li>
1330
1331 <li>Run unpax-icu.sh on the tar file generated from the previous step.
1332 <pre><samp>unpax-icu.sh icu.tar</samp></pre></li>
1333
1334 <li>Build the program ICULD which ICU will use for linkage.
1335 <pre><samp>cd icu/as_is/os400
1336qsh bldiculd.sh
1337cd ../../..</samp></pre>
1338 </li>
1339
1340 <li>Change into the 'source' directory, and configure ICU. (See <a href="#HowToConfigureICU">configuration
1341 note</a> for details). Note that --with-data-packaging=archive and setting the --prefix are recommended, building in default (dll) mode is currently not supported.
1342 <pre><samp>cd icu/source
1343/runConfigureICU IBMi --prefix=<i>/path/to/somewhere</i> --with-data-packaging=archive</samp></pre>
1344</li>
1345
1346 <li>Build ICU. <i>(Note: Do not use the -j option)</i> <pre><samp>gmake</samp></pre></li>
1347
1348 <li>Test ICU. <pre><samp>gmake check</samp></pre>
1349 (The <tt> QIBM_MULTI_THREADED=Y</tt> flag will be automatically applied to intltest -
1350 you can look at the <a href=
1351 "http://publib.boulder.ibm.com/infocenter/iseries/v5r3/index.jsp?topic=/apis/concept4.htm">
1352 iSeries Information Center</a> for more details regarding the running of multiple threads
1353 on IBM i.)</li>
1354 </ol>
1355
1356 <!-- cross -->
1357 <h3><a name="HowToCrossCompileICU" href="#HowToCrossCompileICU" id="HowToCrossCompileICU">How To Cross Compile ICU</a></h3>
1358 <p>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.</p>
1359 <p>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).</p>
1360 <p>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.</p>
1361 <p>The autoconf docs use the term "build" for A, and "host" for B. More details at: <a href="http://www.gnu.org/software/autoconf/manual/html_node/Specifying-Names.html#Specifying-Names">http://www.gnu.org/software/autoconf/manual/html_node/Specifying-Names.html</a></p>
1362 <p>Three initially-empty directories will be used in this example:</p>
1363 <table summary="Three directories used in this example" class="docTable">
1364 <tr>
1365 <th align="left">/icu</th><td>a copy of the ICU source</td>
1366 </tr>
1367 <tr>
1368 <th align="left">/buildA</th><td>an empty directory, it will contain ICU built for A<br />(MacOSX in this case)</td>
1369 </tr>
1370 <tr>
1371 <th align="left">/buildB</th><td>an empty directory, it will contain ICU built for B<br />(HaikuOS in this case)</td>
1372 </tr>
1373 </table>
1374
1375 <ol>
1376 <li>Check out or unpack the ICU source code into the /icu directory.You will have the directories /icu/source, etc.</li>
1377 <li>Build ICU in /buildA normally (using runConfigureICU or configure):
1378<pre class="samp">cd /buildA
1379sh /icu/source/runConfigureICU <strong>MacOSX</strong>
1380gnumake
1381</pre>
1382 </li>
1383 <li>Set PATH or other variables as needed, such as CPPFLAGS.</li>
1384 <li>Build ICU in /buildB<br />
1385 <p class="note">"<code>--with-cross-build</code>" takes an absolute path.</p>
1386<pre class="samp">cd /buildB
1387sh /icu/source/configure --host=<strong>i586-pc-haiku</strong> --with-cross-build=<strong>/buildA</strong>
1388gnumake</pre>
1389 </li>
1390 <li>Tests and testdata can be built with "gnumake tests".</li>
1391 </ol>
1392 <!-- end cross -->
1393
1394 <!-- end build environment -->
1395
1396 <h2><a name="HowToPackage" href="#HowToPackage" id="HowToPackage">How To
1397 Package ICU</a></h2>
1398
1399 <p>There are many ways that a person can package ICU with their software
1400 products. Usually only the libraries need to be considered for packaging.</p>
1401
1402 <p>On UNIX, you should use "<tt>gmake install</tt>" to make it easier to
1403 develop and package ICU. The bin, lib and include directories are needed to
1404 develop applications that use ICU. These directories will be created relative
1405 to the "<tt>--prefix=</tt><i>dir</i>" configure option (See the <a href=
1406 "#HowToBuildUNIX">UNIX build instructions</a>). When ICU is built on Windows,
1407 a similar directory structure is built.</p>
1408
1409 <p>When changes have been made to the standard ICU distribution, it is
1410 recommended that at least one of the following guidelines be followed for
1411 special packaging.</p>
1412
1413 <ol>
1414 <li>Add a suffix name to the library names. This can be done with the
1415 --with-library-suffix configure option.</li>
1416
1417 <li>The installation script should install the ICU libraries into the
1418 application's directory.</li>
1419 </ol>
1420
1421 <p>Following these guidelines prevents other applications that use a standard
1422 ICU distribution from conflicting with any libraries that you need. On
1423 operating systems that do not have a standard C++ ABI (name mangling) for
1424 compilers, it is recommended to do this special packaging anyway. More
1425 details on customizing ICU are available in the <a href=
1426 "http://userguide.icu-project.org/">User's Guide</a>. The <a href=
1427 "#SourceCode">ICU Source Code Organization</a> section of this readme.html
1428 gives a more complete description of the libraries.</p>
1429
1430 <table class="docTable" summary=
1431 "ICU has several libraries for you to use.">
1432 <caption>
1433 Here is an example of libraries that are frequently packaged.
1434 </caption>
1435
1436 <tr>
1437 <th scope="col">Library Name</th>
1438
1439 <th scope="col">Windows Filename</th>
1440
1441 <th scope="col">Linux Filename</th>
1442
1443 <th scope="col">Comment</th>
1444 </tr>
1445
1446 <tr>
1447 <td>Data Library</td>
1448
1449 <td>icudt<i>XY</i>l.dll</td>
1450
1451 <td>libicudata.so.<i>XY</i>.<i>Z</i></td>
1452
1453 <td>Data required by the Common and I18n libraries. There are many ways
1454 to package and <a href=
1455 "http://userguide.icu-project.org/icudata">customize this
1456 data</a>, but by default this is all you need.</td>
1457 </tr>
1458
1459 <tr>
1460 <td>Common Library</td>
1461
1462 <td>icuuc<i>XY</i>.dll</td>
1463
1464 <td>libicuuc.so.<i>XY</i>.<i>Z</i></td>
1465
1466 <td>Base library required by all other ICU libraries.</td>
1467 </tr>
1468
1469 <tr>
1470 <td>Internationalization (i18n) Library</td>
1471
1472 <td>icuin<i>XY</i>.dll</td>
1473
1474 <td>libicui18n.so.<i>XY</i>.<i>Z</i></td>
1475
1476 <td>A library that contains many locale based internationalization (i18n)
1477 functions.</td>
1478 </tr>
1479
1480 <tr>
1481 <td>Layout Engine</td>
1482
1483 <td>icule<i>XY</i>.dll</td>
1484
1485 <td>libicule.so.<i>XY</i>.<i>Z</i></td>
1486
1487 <td>An optional engine for doing font layout.</td>
1488 </tr>
1489
1490 <tr>
1491 <td>Layout Extensions Engine</td>
1492
1493 <td>iculx<i>XY</i>.dll</td>
1494
1495 <td>libiculx.so.<i>XY</i>.<i>Z</i></td>
1496
1497 <td>An optional engine for doing font layout that uses parts of ICU.</td>
1498 </tr>
1499
1500 <tr>
1501 <td>ICU I/O (Unicode stdio) Library</td>
1502
1503 <td>icuio<i>XY</i>.dll</td>
1504
1505 <td>libicuio.so.<i>XY</i>.<i>Z</i></td>
1506
1507 <td>An optional library that provides a stdio like API with Unicode
1508 support.</td>
1509 </tr>
1510
1511 <tr>
1512 <td>Tool Utility Library</td>
1513
1514 <td>icutu<i>XY</i>.dll</td>
1515
1516 <td>libicutu.so.<i>XY</i>.<i>Z</i></td>
1517
1518 <td>An internal library that contains internal APIs that are only used by
1519 ICU's tools. If you do not use ICU's tools, you do not need this
1520 library.</td>
1521 </tr>
1522 </table>
1523
1524 <p>Normally only the above ICU libraries need to be considered for packaging.
1525 The versionless symbolic links to these libraries are only needed for easier
1526 development. The <i>X</i>, <i>Y</i> and <i>Z</i> parts of the name are the
1527 version numbers of ICU. For example, ICU 2.0.2 would have the name
1528 libicuuc.so.20.2 for the common library. The exact format of the library
1529 names can vary between platforms due to how each platform can handles library
1530 versioning.</p>
1531
1532 <h2><a name="ImportantNotes" href="#ImportantNotes" id=
1533 "ImportantNotes">Important Notes About Using ICU</a></h2>
1534
1535 <h3><a name="ImportantNotesMultithreaded" href="#ImportantNotesMultithreaded"
1536 id="ImportantNotesMultithreaded">Using ICU in a Multithreaded
1537 Environment</a></h3>
1538
1539 <p>Some versions of ICU require calling the <code>u_init()</code> function
1540 from <code>uclean.h</code> to ensure that ICU is initialized properly. In
1541 those ICU versions, <code>u_init()</code> must be called before ICU is used
1542 from multiple threads. There is no harm in calling <code>u_init()</code> in a
1543 single-threaded application, on a single-CPU machine, or in other cases where
1544 <code>u_init()</code> is not required.</p>
1545
1546 <p>In addition to ensuring thread safety, <code>u_init()</code> also attempts
1547 to load at least one ICU data file. Assuming that all data files are packaged
1548 together (or are in the same folder in files mode), a failure code from
1549 <code>u_init()</code> usually means that the data cannot be found. In this
1550 case, the data may not be installed properly, or the application may have
1551 failed to call <code>udata_setCommonData()</code> or
1552 <code>u_setDataDirectory()</code> which specify to ICU where it can find its
1553 data.</p>
1554
1555 <p>Since <code>u_init()</code> will load only one or two data files, it
1556 cannot guarantee that all of the data that an application needs is available.
1557 It cannot check for all data files because the set of files is customizable,
1558 and some ICU services work without loading any data at all. An application
1559 should always check for error codes when opening ICU service objects (using
1560 <code>ucnv_open()</code>, <code>ucol_open()</code>, C++ constructors,
1561 etc.).</p>
1562
1563 <h4>ICU 3.4 and later</h4>
1564
1565 <p>ICU 3.4 self-initializes properly for multi-threaded use. It achieves this
1566 without performance penalty by hardcoding the core Unicode properties data,
1567 at the cost of some flexibility. (For details see Jitterbug 4497.)</p>
1568
1569 <p><code>u_init()</code> can be used to check for data loading. It tries to
1570 load the converter alias table (<code>cnvalias.icu</code>).</p>
1571
1572 <h4>ICU 2.6..3.2</h4>
1573
1574 <p>These ICU versions require a call to <code>u_init()</code> before
1575 multi-threaded use. The services that are directly affected are those that
1576 don't have a service object and need to be fast: normalization and character
1577 properties.</p>
1578
1579 <p><code>u_init()</code> loads and initializes the data files for
1580 normalization and character properties (<code>unorm.icu</code> and
1581 <code>uprops.icu</code>) and can therefore also be used to check for data
1582 loading.</p>
1583
1584 <h4>ICU 2.4 and earlier</h4>
1585
1586 <p>ICU 2.4 and earlier versions were not prepared for multithreaded use on
1587 multi-CPU platforms where the CPUs implement weak memory coherency. These
1588 CPUs include: Power4, Power5, Alpha, Itanium. <code>u_init()</code> was not
1589 defined yet.</p>
1590
1591 <h4><a name="ImportantNotesHPUX" href="#ImportantNotesHPUX" id=
1592 "ImportantNotesHPUX">Using ICU in a Multithreaded Environment on
1593 HP-UX</a></h4>
1594
1595 <p>When ICU is built with aCC on HP-UX, the <a
1596 href="http://h21007.www2.hp.com/portal/site/dspp/menuitem.863c3e4cbcdc3f3515b49c108973a801?ciid=eb08b3f1eee02110b3f1eee02110275d6e10RCRD">-AA</a>
1597 compiler flag is used. It is required in order to use the latest
1598 <iostream> API in a thread safe manner. This compiler flag affects the
1599 version of the C++ library being used. Your applications will also need to
1600 be compiled with -AA in order to use ICU.</p>
1601
1602 <h4><a name="ImportantNotesSolaris" href="#ImportantNotesSolaris" id=
1603 "ImportantNotesSolaris">Using ICU in a Multithreaded Environment on
1604 Solaris</a></h4>
1605
1606 <h5>Linking on Solaris</h5>
1607
1608 <p>In order to avoid synchronization and threading issues, developers are
1609 <strong>suggested</strong> to strictly follow the compiling and linking
1610 guidelines for multithreaded applications, specified in the following
1611 document from Sun Microsystems. Most notably, pay strict attention to the
1612 following statements from Sun:</p>
1613
1614 <blockquote>
1615 <p>To use libthread, specify -lthread before -lc on the ld command line, or
1616 last on the cc command line.</p>
1617
1618 <p>To use libpthread, specify -lpthread before -lc on the ld command line,
1619 or last on the cc command line.</p>
1620 </blockquote>
1621
1622 <p>Failure to do this may cause spurious lock conflicts, recursive mutex
1623 failure, and deadlock.</p>
1624
1625 <p>Source: "<i>Solaris Multithreaded Programming Guide, Compiling and
1626 Debugging</i>", Sun Microsystems, Inc., Apr 2004<br />
1627 <a href=
1628 "http://docs.sun.com/app/docs/doc/816-5137/6mba5vpke?a=view">http://docs.sun.com/app/docs/doc/816-5137/6mba5vpke?a=view</a></p>
1629
1630 <h3><a name="ImportantNotesWindows" href="#ImportantNotesWindows" id=
1631 "ImportantNotesWindows">Windows Platform</a></h3>
1632
1633 <p>If you are building on the Win32 platform, it is important that you
1634 understand a few of the following build details.</p>
1635
1636 <h4>DLL directories and the PATH setting</h4>
1637
1638 <p>As delivered, the International Components for Unicode build as several
1639 DLLs, which are placed in the "<i><ICU></i>\bin" directory. You must
1640 add this directory to the PATH environment variable in your system, or any
1641 executables you build will not be able to access International Components for
1642 Unicode libraries. Alternatively, you can copy the DLL files into a directory
1643 already in your PATH, but we do not recommend this. You can wind up with
1644 multiple copies of the DLL and wind up using the wrong one.</p>
1645
1646 <h4><a name="ImportantNotesWindowsPath" id=
1647 "ImportantNotesWindowsPath">Changing your PATH</a></h4>
1648
1649 <p><strong>Windows 2000/XP</strong>: Use the System Icon in the Control
1650 Panel. Pick the "Advanced" tab. Select the "Environment Variables..."
1651 button. Select the variable PATH in the lower box, and select the lower
1652 "Edit..." button. In the "Variable Value" box, append the string
1653 ";<i><ICU></i>\bin" to the end of the path string. If there is
1654 nothing there, just type in "<i><ICU></i>\bin". Click the Set button,
1655 then the OK button.</p>
1656
1657 <p>Note: When packaging a Windows application for distribution and
1658 installation on user systems, copies of the ICU DLLs should be included with
1659 the application, and installed for exclusive use by the application. This is
1660 the only way to insure that your application is running with the same version
1661 of ICU, built with exactly the same options, that you developed and tested
1662 with. Refer to Microsoft's guidelines on the usage of DLLs, or search for the
1663 phrase "DLL hell" on <a href=
1664 "http://msdn.microsoft.com/">msdn.microsoft.com</a>.</p>
1665
1666 <h3><a name="ImportantNotesUNIX" href="#ImportantNotesUNIX" id=
1667 "ImportantNotesUNIX">UNIX Type Platform</a></h3>
1668
1669 <p>If you are building on a UNIX platform, and if you are installing ICU in a
1670 non-standard location, you may need to add the location of your ICU libraries
1671 to your <strong>LD_LIBRARY_PATH</strong> or <strong>LIBPATH</strong>
1672 environment variable (or the equivalent runtime library path environment
1673 variable for your system). The ICU libraries may not link or load properly
1674 without doing this.</p>
1675
1676 <p>Note that if you do not want to have to set this variable, you may instead
1677 use the --enable-rpath option at configuration time. This option will
1678 instruct the linker to always look for the libraries where they are
1679 installed. You will need to use the appropriate linker options when linking
1680 your own applications and libraries against ICU, too. Please refer to your
1681 system's linker manual for information about runtime paths. The use of rpath
1682 also means that when building a new version of ICU you should not have an
1683 older version installed in the same place as the new version's installation
1684 directory, as the older libraries will used during the build, instead of the
1685 new ones, likely leading to an incorrectly build ICU. This is the proper
1686 behavior of rpath.</p>
1687
1688 <h2><a name="PlatformDependencies" href="#PlatformDependencies" id=
1689 "PlatformDependencies">Platform Dependencies</a></h2>
1690
1691 <h3><a name="PlatformDependenciesNew" href="#PlatformDependenciesNew" id=
1692 "PlatformDependenciesNew">Porting To A New Platform</a></h3>
1693
1694 <p>If you are using ICU's Makefiles to build ICU on a new platform, there are
1695 a few places where you will need to add or modify some files. If you need
1696 more help, you can always ask the <a href=
1697 "http://site.icu-project.org/contacts">icu-support mailing list</a>. Once
1698 you have finished porting ICU to a new platform, it is recommended that you
1699 contribute your changes back to ICU via the icu-support mailing list. This
1700 will make it easier for everyone to benefit from your work.</p>
1701
1702 <h4>Data For a New Platform</h4>
1703
1704 <p>For some people, it may not be necessary for completely build ICU. Most of
1705 the makefiles and build targets are for tools that are used for building
1706 ICU's data, and an application's data (when an application uses ICU resource
1707 bundles for its data).</p>
1708
1709 <p>Data files can be built on a different platform when both platforms share
1710 the same endianness and the same charset family. This assertion does not
1711 include platform dependent DLLs/shared/static libraries. For details see the
1712 User Guide <a href="http://userguide.icu-project.org/icudata">ICU
1713 Data</a> chapter.</p>
1714
1715 <p>ICU 3.6 removes the requirement that ICU be completely built in the native
1716 operating environment. It adds the icupkg tool which can be run on any
1717 platform to turn binary ICU data files from any one of the three formats into
1718 any one of the other data formats. This allows a application to use ICU data
1719 built anywhere to be used for any other target platform.</p>
1720
1721 <p><strong>WARNING!</strong> Building ICU without running the tests is not
1722 recommended. The tests verify that ICU is safe to use. It is recommended that
1723 you try to completely port and test ICU before using the libraries for your
1724 own application.</p>
1725
1726 <h4>Adapting Makefiles For a New Platform</h4>
1727
1728 <p>Try to follow the build steps from the <a href="#HowToBuildUNIX">UNIX</a>
1729 build instructions. If the configure script fails, then you will need to
1730 modify some files. Here are the usual steps for porting to a new
1731 platform:<br />
1732 </p>
1733
1734 <ol>
1735 <li>Create an mh file in icu/source/config/. You can use mh-linux or a
1736 similar mh file as your base configuration.</li>
1737
1738 <li>Modify icu/source/aclocal.m4 to recognize your platform's mh file.</li>
1739
1740 <li>Modify icu/source/configure.in to properly set your <b>platform</b> C
1741 Macro define.</li>
1742
1743 <li>Run <a href="http://www.gnu.org/software/autoconf/">autoconf</a> in
1744 icu/source/ without any options. The autoconf tool is standard on most
1745 Linux systems.</li>
1746
1747 <li>If you have any optimization options that you want to normally use, you
1748 can modify icu/source/runConfigureICU to specify those options for your
1749 platform.</li>
1750
1751 <li>Build and test ICU on your platform. It is very important that you run
1752 the tests. If you don't run the tests, there is no guarentee that you have
1753 properly ported ICU.</li>
1754 </ol>
1755
1756 <h3><a name="PlatformDependenciesImpl" href="#PlatformDependenciesImpl" id=
1757 "PlatformDependenciesImpl">Platform Dependent Implementations</a></h3>
1758
1759 <p>The platform dependencies have been mostly isolated into the following
1760 files in the common library. This information can be useful if you are
1761 porting ICU to a new platform.</p>
1762
1763 <ul>
1764 <li>
1765 <strong>unicode/platform.h.in</strong> (autoconf'ed platforms)<br />
1766 <strong>unicode/p<i>XXXX</i>.h</strong> (others: pwin32.h, ppalmos.h,
1767 ..): Platform-dependent typedefs and defines:<br />
1768 <br />
1769
1770
1771 <ul>
1772 <li>Generic types like UBool, int8_t, int16_t, int32_t, int64_t,
1773 uint64_t etc.</li>
1774
1775 <li>U_EXPORT and U_IMPORT for specifying dynamic library import and
1776 export</li>
1777
1778 <li>String handling support for the char16_t and wchar_t types.</li>
1779 </ul>
1780 <br />
1781 </li>
1782
1783 <li>
1784 <strong>unicode/putil.h, putil.c</strong>: platform-dependent
1785 implementations of various functions that are platform dependent:<br />
1786 <br />
1787
1788
1789 <ul>
1790 <li>uprv_isNaN, uprv_isInfinite, uprv_getNaN and uprv_getInfinity for
1791 handling special floating point values.</li>
1792
1793 <li>uprv_tzset, uprv_timezone, uprv_tzname and time for getting
1794 platform specific time and time zone information.</li>
1795
1796 <li>u_getDataDirectory for getting the default data directory.</li>
1797
1798 <li>uprv_getDefaultLocaleID for getting the default locale
1799 setting.</li>
1800
1801 <li>uprv_getDefaultCodepage for getting the default codepage
1802 encoding.</li>
1803 </ul>
1804 <br />
1805 </li>
1806
1807 <li>
1808 <strong>umutex.h, umutex.c</strong>: Code for doing synchronization in
1809 multithreaded applications. If you wish to use International Components
1810 for Unicode in a multithreaded application, you must provide a
1811 synchronization primitive that the classes can use to protect their
1812 global data against simultaneous modifications. We already supply working
1813 implementations for many platforms that ICU builds on.<br />
1814 <br />
1815 </li>
1816
1817 <li><strong>umapfile.h, umapfile.c</strong>: functions for mapping or
1818 otherwise reading or loading files into memory. All access by ICU to data
1819 from files makes use of these functions.<br />
1820 <br />
1821 </li>
1822
1823 <li>Using platform specific #ifdef macros are highly discouraged outside of
1824 the scope of these files. When the source code gets updated in the future,
1825 these #ifdef's can cause testing problems for your platform.</li>
1826 </ul>
1827 <hr />
1828
1829 <p>Copyright © 1997-2015 International Business Machines Corporation and
1830 others. All Rights Reserved.<br />
1831 IBM Globalization Center of Competency - San José<br />
1832 4400 North First Street<br />
1833 San José, CA 95134<br />
1834 USA</p>
1835 </body>
1836</html>
1837