-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.html
1774 lines (1412 loc) · 77.9 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en-US" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<title>ReadMe for ICU 53.1</title>
<meta name="COPYRIGHT" content=
"Copyright (c) 1997-2014 IBM Corporation and others. All Rights Reserved." />
<meta name="KEYWORDS" content=
"ICU; International Components for Unicode; ICU4C; what's new; readme; read me; introduction; downloads; downloading; building; installation;" />
<meta name="DESCRIPTION" content=
"The introduction to the International Components for Unicode with instructions on building, installation, usage and other information about ICU." />
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<link type="text/css" href="./icu4c.css" rel="stylesheet"/>
</head>
<body class="draft">
<h1>International Components for Unicode<br/>
<abbr title="International Components for Unicode">ICU</abbr> 53.1 ReadMe</h1>
<!--
<p><b>Note:</b> This is a development milestone release of ICU4C 53
This milestone is intended for those wishing to get an early look at ICU 53 new features and API changes.
It is not recommended for production use.</p>
-->
<!--
<p><b>Note:</b> This is a release candidate version of ICU4C 53.
It is not recommended for production use.</p>
-->
<p>Last updated: 2014-Mar-31<br />
Copyright © 1997-2014 International Business Machines Corporation and
others. All Rights Reserved.</p>
<!-- Remember that there is a copyright at the end too -->
<hr/>
<h2 class="TOC">Table of Contents</h2>
<ul class="TOC">
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#GettingStarted">Getting Started</a></li>
<li><a href="#News">What Is New In This release?</a></li>
<li><a href="#Download">How To Download the Source Code</a></li>
<li><a href="#SourceCode">ICU Source Code Organization</a></li>
<li>
<a href="#HowToBuild">How To Build And Install ICU</a>
<ul >
<li><a href="#RecBuild">Recommended Build Options</a></li>
<li><a href="#UserConfig">User-Configurable Settings</a></li>
<li><a href="#HowToBuildWindows">Windows</a></li>
<li><a href="#HowToBuildCygwin">Cygwin</a></li>
<li><a href="#HowToBuildUNIX">UNIX</a></li>
<li><a href="#HowToBuildZOS">z/OS (os/390)</a></li>
<li><a href="#HowToBuildOS400">IBM i family (IBM i, i5/OS, OS/400)</a></li>
<li><a href="#HowToCrossCompileICU">How to Cross Compile ICU</a></li>
</ul>
</li>
<li><a href="#HowToPackage">How To Package ICU</a></li>
<li>
<a href="#ImportantNotes">Important Notes About Using ICU</a>
<ul >
<li><a href="#ImportantNotesMultithreaded">Using ICU in a Multithreaded
Environment</a></li>
<li><a href="#ImportantNotesWindows">Windows Platform</a></li>
<li><a href="#ImportantNotesUNIX">UNIX Type Platforms</a></li>
</ul>
</li>
<li>
<a href="#PlatformDependencies">Platform Dependencies</a>
<ul >
<li><a href="#PlatformDependenciesNew">Porting To A New
Platform</a></li>
<li><a href="#PlatformDependenciesImpl">Platform Dependent
Implementations</a></li>
</ul>
</li>
</ul>
<hr />
<h2><a name="Introduction" href="#Introduction" id=
"Introduction">Introduction</a></h2>
<p>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 (ICU) libraries provide robust and full-featured Unicode services on
a wide variety of platforms to help this design goal. The ICU libraries
provide support for:</p>
<ul>
<li>The latest version of the Unicode standard</li>
<li>Character set conversions with support for over 220 codepages</li>
<li>Locale data for more than 300 locales</li>
<li>Language sensitive text collation (sorting) and searching based on the
Unicode Collation Algorithm (=ISO 14651)</li>
<li>Regular expression matching and Unicode sets</li>
<li>Transformations for normalization, upper/lowercase, script
transliterations (50+ pairs)</li>
<li>Resource bundles for storing and accessing localized information</li>
<li>Date/Number/Message formatting and parsing of culture specific
input/output formats</li>
<li>Calendar specific date and time manipulation</li>
<li>Complex text layout for Arabic, Hebrew, Indic and Thai</li>
<li>Text boundary analysis for finding characters, word and sentence
boundaries</li>
</ul>
<p>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.</p>
<h2><a name="GettingStarted" href="#GettingStarted" id=
"GettingStarted">Getting started</a></h2>
<p>This document describes how to build and install ICU on your machine. For
other information about ICU please see the following table of links.<br />
The ICU homepage also links to related information about writing
internationalized software.</p>
<table class="docTable" summary="These are some useful links regarding ICU and internationalization in general.">
<caption>
Here are some useful links regarding ICU and internationalization in
general.
</caption>
<tr>
<td>ICU, ICU4C & ICU4J Homepage</td>
<td><a href=
"http://icu-project.org/">http://icu-project.org/</a></td>
</tr>
<tr>
<td>FAQ - Frequently Asked Questions about ICU</td>
<td><a href=
"http://userguide.icu-project.org/icufaq">http://userguide.icu-project.org/icufaq</a></td>
</tr>
<tr>
<td>ICU User's Guide</td>
<td><a href=
"http://userguide.icu-project.org/">http://userguide.icu-project.org/</a></td>
</tr>
<tr>
<td>How To Use ICU</td>
<td><a href="http://userguide.icu-project.org/howtouseicu">http://userguide.icu-project.org/howtouseicu</a></td>
</tr>
<tr>
<td>Download ICU Releases</td>
<td><a href=
"http://site.icu-project.org/download">http://site.icu-project.org/download</a></td>
</tr>
<tr>
<td>ICU4C API Documentation Online</td>
<td><a href=
"http://icu-project.org/apiref/icu4c/">http://icu-project.org/apiref/icu4c/</a></td>
</tr>
<tr>
<td>Online ICU Demos</td>
<td><a href=
"http://demo.icu-project.org/icu-bin/icudemos">http://demo.icu-project.org/icu-bin/icudemos</a></td>
</tr>
<tr>
<td>Contacts and Bug Reports/Feature Requests</td>
<td><a href=
"http://site.icu-project.org/contacts">http://site.icu-project.org/contacts</a></td>
</tr>
</table>
<p><strong>Important:</strong> Please make sure you understand the <a href=
"license.html">Copyright and License Information</a>.</p>
<h2><a name="News" href="#News" id="News">What is new in this
release?</a></h2>
<p>To see which APIs are new or changed in this release, view the <a href="APIChangeReport.html">ICU4C API Change Report</a>. </p>
<h3></h3><!-- for a horizotal rule matching those at the beginning of each h3 -->
<p>The following list concentrates on <em>changes that affect existing
applications migrating from previous ICU releases</em>.
For more news about this release, see the
<a href="http://site.icu-project.org/download/53">ICU download page</a>.
<!-- <a href="http://site.icu-project.org/download/milestone">ICU milestone download page</a>. -->
</p>
<!-- ICU 53 items -->
<h3>ICU4C now requires C99</h3>
<p>ICU4C must be built with compilers (or compiler options) that support C99 (ISO/IEC 9899:1999).</p>
<h3>Collation code re-implemented</h3>
<ul>
<li>New, incompatible data format of the binary collation data in
coll/*.res and coll/ucadata.icu data files.
coll/invuca.icu has been removed.</li>
<li>Data loading will not fall back to building from rules any more
when the binary data is missing or does not match the current implementation.
(This removes the dependency from the "runtime" code on the builder.)</li>
<li>Rule syntax and semantics tightened and improved, matching
<a href="http://unicode.org/repos/cldr/trunk/specs/ldml/tr35-collation.html#Rules">LDML 25 Collation Rule Syntax</a>
(TODO: update link for released LDML 25)
<ul>
<li>In particular, rule chains now must start with a reset.</li>
</ul>
</li>
<li>Setting of variableTop deprecated, and not supported in rule syntax any more
<ul>
<li>Replaced by the new maxVariable setting; see
<a href="http://unicode.org/repos/cldr/trunk/specs/ldml/tr35-collation.html#Collation_Settings">LDML 25 Collation Settings</a>
(TODO: update link for released LDML 25)</li>
</ul>
</li>
</ul>
<!-- end ICU 53 items -->
<h2><a name="Download" href="#Download" id="Download">How To Download the
Source Code</a></h2>
<p>There are two ways to download ICU releases:</p>
<ul>
<li><strong>Official Release Snapshot:</strong><br />
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 <a href=
"http://site.icu-project.org/download">http://site.icu-project.org/download</a>.<br />
The packaged snapshots are named <strong>icu-nnnn.zip</strong> or
<strong>icu-nnnn.tgz</strong>, where nnnn is the version number. The .zip
file is used for Windows platforms, while the .tgz file is preferred on
most other platforms.<br />
Please unzip this file. </li>
<li><strong>Subversion Source Repository:</strong><br />
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 Subversion repository to
ensure that you have the most recent version of all of the files. See our
<a href="http://site.icu-project.org/repository">source
repository</a> for details.</li>
</ul>
<h2><a name="SourceCode" href="#SourceCode" id="SourceCode">ICU Source Code
Organization</a></h2>
<p>In the descriptions below, <strong><i><ICU></i></strong> 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 <a href=
"http://userguide.icu-project.org/design">ICU Architectural
Design</a> section of the User's Guide to see which libraries you need for
your software product. You need at least the data (<code>[lib]icudt</code>)
and the common (<code>[lib]icuuc</code>) libraries in order to use ICU.</p>
<table class="docTable" summary="The following files describe the code drop.">
<caption>
The following files describe the code drop.
</caption>
<tr>
<th scope="col">File</th>
<th scope="col">Description</th>
</tr>
<tr>
<td>readme.html</td>
<td>Describes the International Components for Unicode (this file)</td>
</tr>
<tr>
<td>license.html</td>
<td>Contains the text of the ICU license</td>
</tr>
</table>
<p><br />
</p>
<table class="docTable" summary=
"The following directories contain source code and data files.">
<caption>
The following directories contain source code and data files.
</caption>
<tr>
<th scope="col">Directory</th>
<th scope="col">Description</th>
</tr>
<tr>
<td><i><ICU></i>/source/<b>common</b>/</td>
<td>The core Unicode and support functionality, such as resource bundles,
character properties, locales, codepage conversion, normalization,
Unicode properties, Locale, and UnicodeString.</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>i18n</b>/</td>
<td>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.</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>layout</b>/</td>
<td>Contains the ICU layout engine (not a rasterizer).</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>io</b>/</td>
<td>Contains the ICU I/O library.</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>data</b>/</td>
<td>
<p>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.</p>
<p>If some of the following directories are missing, it's probably
because you got an official download. If you need the data source files
for customization, then please download the ICU source code from <a
href="http://site.icu-project.org/repository">subversion</a>.</p>
<ul>
<li><b>in/</b> A directory that contains a pre-built data library for
ICU. A standard source code package will contain this file without
several of the following directories. This is to simplify the build
process for the majority of users and to reduce platform porting
issues.</li>
<li><b>brkitr/</b> Data files for character, word, sentence, title
casing and line boundary analysis.</li>
<li><b>locales/</b> These .txt files contain ICU language and
culture-specific localization data. Two special bundles are
<b>root</b>, which is the fallback data and parent of other bundles,
and <b>index</b>, which contains a list of installed bundles. The
makefile <b>resfiles.mk</b> contains the list of resource bundle
files.</li>
<li><b>mappings/</b> Here are the code page converter tables. These
.ucm files contain mappings to and from Unicode. These are compiled
into .cnv files. <b>convrtrs.txt</b> is the alias mapping table from
various converter name formats to ICU internal format and vice versa.
It produces cnvalias.icu. The makefiles <b>ucmfiles.mk,
ucmcore.mk,</b> and <b>ucmebcdic.mk</b> contain the list of
converters to be built.</li>
<li><b>translit/</b> This directory contains transliterator rules as
resource bundles, a makefile <b>trnsfiles.mk</b> containing the list
of installed system translitaration files, and as well the special
bundle <b>translit_index</b> which lists the system transliterator
aliases.</li>
<li><b>unidata/</b> This directory contains the Unicode data files.
Please see <a href=
"http://www.unicode.org/">http://www.unicode.org/</a> for more
information.</li>
<li><b>misc/</b> The misc directory contains other data files which
did not fit into the above categories. Currently it only contains
time zone information, and a name preperation file for <a href=
"http://www.ietf.org/rfc/rfc3490.txt">IDNA</a>.</li>
<li><b>out/</b> This directory contains the assembled memory mapped
files.</li>
<li><b>out/build/</b> This directory contains intermediate (compiled)
files, such as .cnv, .res, etc.</li>
</ul>
<p>If you are creating a special ICU build, you can set the ICU_DATA
environment variable to the out/ or the out/build/ directories, but
this is generally discouraged because most people set it incorrectly.
You can view the <a href=
"http://userguide.icu-project.org/icudata">ICU Data
Management</a> section of the ICU User's Guide for details.</p>
</td>
</tr>
<tr>
<td><i><ICU></i>/source/test/<b>intltest</b>/</td>
<td>A test suite including all C++ APIs. For information about running
the test suite, see the build instructions specific to your platform
later in this document.</td>
</tr>
<tr>
<td><i><ICU></i>/source/test/<b>cintltst</b>/</td>
<td>A test suite written in C, including all C APIs. For information
about running the test suite, see the build instructions specific to your
platform later in this document.</td>
</tr>
<tr>
<td><i><ICU></i>/source/test/<b>iotest</b>/</td>
<td>A test suite written in C and C++ to test the icuio library. For
information about running the test suite, see the build instructions
specific to your platform later in this document.</td>
</tr>
<tr>
<td><i><ICU></i>/source/test/<b>testdata</b>/</td>
<td>Source text files for data, which are read by the tests. It contains
the subdirectories <b>out/build/</b> which is used for intermediate
files, and <b>out/</b> which contains <b>testdata.dat.</b></td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>tools</b>/</td>
<td>Tools for generating the data files. Data files are generated by
invoking <i><ICU></i>/source/data/build/makedata.bat on Win32 or
<i><ICU></i>/source/make on UNIX.</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>samples</b>/</td>
<td>Various sample programs that use ICU</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>extra</b>/</td>
<td>Non-supported API additions. Currently, it contains the 'uconv' tool
to perform codepage conversion on files.</td>
</tr>
<tr>
<td><i><ICU></i>/<b>packaging</b>/</td>
<td>This directory contain scripts and tools for packaging the final
ICU build for various release platforms.</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>config</b>/</td>
<td>Contains helper makefiles for platform specific build commands. Used
by 'configure'.</td>
</tr>
<tr>
<td><i><ICU></i>/source/<b>allinone</b>/</td>
<td>Contains top-level ICU workspace and project files, for instance to
build all of ICU under one MSVC project.</td>
</tr>
<tr>
<td><i><ICU></i>/<b>include</b>/</td>
<td>Contains the headers needed for developing software that uses ICU on
Windows.</td>
</tr>
<tr>
<td><i><ICU></i>/<b>lib</b>/</td>
<td>Contains the import libraries for linking ICU into your Windows
application.</td>
</tr>
<tr>
<td><i><ICU></i>/<b>bin</b>/</td>
<td>Contains the libraries and executables for using ICU on Windows.</td>
</tr>
</table>
<!-- end of ICU structure ==================================== -->
<h2><a name="HowToBuild" href="#HowToBuild" id="HowToBuild">How To Build And
Install ICU</a></h2>
<h3><a name="RecBuild" href="#RecBuild" id=
"RecBuild">Recommended Build Options</a></h3>
<p>Depending on the platform and the type of installation,
we recommend a small number of modifications and build options.
Note that C99 compatibility is now required.</p>
<ul>
<li><b>Namespace:</b> By default, unicode/uversion.h has
"using namespace icu;" which defeats much of the purpose of the namespace.
(This is for historical reasons: Originally, ICU4C did not use namespaces,
and some compilers did not support them. The default "using" statement
preserves source code compatibility.)<br />
We recommend you turn this off via <code>-DU_USING_ICU_NAMESPACE=0</code>
or by modifying unicode/uversion.h:
<pre>Index: source/common/unicode/uversion.h
===================================================================
--- source/common/unicode/uversion.h (revision 26606)
+++ source/common/unicode/uversion.h (working copy)
@@ -180,7 +180,8 @@
# define U_NAMESPACE_QUALIFIER U_ICU_NAMESPACE::
# ifndef U_USING_ICU_NAMESPACE
-# define U_USING_ICU_NAMESPACE 1
+ // Set to 0 to force namespace declarations in ICU usage.
+# define U_USING_ICU_NAMESPACE 0
# endif
# if U_USING_ICU_NAMESPACE
U_NAMESPACE_USE
</pre>
ICU call sites then either qualify ICU types explicitly,
for example <code>icu::UnicodeString</code>,
or do <code>using icu::UnicodeString;</code> where appropriate.</li>
<li><b>Hardcode the default charset to UTF-8:</b> On platforms where
the default charset is always UTF-8,
like MacOS X and some Linux distributions,
we recommend hardcoding ICU's default charset to UTF-8.
This means that some implementation code becomes simpler and faster,
and statically linked ICU libraries become smaller.
(See the <a href="http://icu-project.org/apiref/icu4c/utypes_8h.html#0a33e1edf3cd23d9e9c972b63c9f7943">U_CHARSET_IS_UTF8</a>
API documentation for more details.)<br />
You can <code>-DU_CHARSET_IS_UTF8=1</code> or
modify unicode/utypes.h (in ICU 4.8 and below)
or modify unicode/platform.h (in ICU 49 and higher):
<pre>Index: source/common/unicode/utypes.h
===================================================================
--- source/common/unicode/utypes.h (revision 26606)
+++ source/common/unicode/utypes.h (working copy)
@@ -160,7 +160,7 @@
* @see UCONFIG_NO_CONVERSION
*/
#ifndef U_CHARSET_IS_UTF8
-# define U_CHARSET_IS_UTF8 0
+# define U_CHARSET_IS_UTF8 1
#endif
/*===========================================================================*/
</pre></li>
<li><b>UnicodeString constructors:</b> The UnicodeString class has
several single-argument constructors that are not marked "explicit"
for historical reasons.
This can lead to inadvertent construction of a <code>UnicodeString</code>
with a single character by using an integer,
and it can lead to inadvertent dependency on the conversion framework
by using a C string literal.<br />
Beginning with ICU 49, you should do the following:
<ul>
<li>Consider marking the from-<code>UChar</code>
and from-<code>UChar32</code> constructors explicit via
<code>-DUNISTR_FROM_CHAR_EXPLICIT=explicit</code> or similar.</li>
<li>Consider marking the from-<code>const char*</code> and
from-<code>const UChar*</code> constructors explicit via
<code>-DUNISTR_FROM_STRING_EXPLICIT=explicit</code> or similar.</li>
</ul>
Note: The ICU test suites cannot be compiled with these settings.
</li>
<li><b>utf.h, utf8.h, utf16.h, utf_old.h:</b>
By default, utypes.h (and thus almost every public ICU header)
includes all of these header files.
Often, none of them are needed, or only one or two of them.
All of utf_old.h is deprecated or obsolete.<br />
Beginning with ICU 49,
you should define <code>U_NO_DEFAULT_INCLUDE_UTF_HEADERS</code> to 1
(via -D or uconfig.h, as above)
and include those header files explicitly that you actually need.<br />
Note: The ICU test suites cannot be compiled with this setting.</li>
<li><b>.dat file:</b> By default, the ICU data is built into
a shared library (DLL). This is convenient because it requires no
install-time or runtime configuration,
but the library is platform-specific and cannot be modified.
A .dat package file makes the opposite trade-off:
Platform-portable (except for endianness and charset family, which
can be changed with the icupkg tool)
and modifiable (also with the icupkg tool).
If a path is set, then single data files (e.g., .res files)
can be copied to that location to provide new locale data
or conversion tables etc.<br />
The only drawback with a .dat package file is that the application
needs to provide ICU with the file system path to the package file
(e.g., by calling <code>u_setDataDirectory()</code>)
or with a pointer to the data (<code>udata_setCommonData()</code>)
before other ICU API calls.
This is usually easy if ICU is used from an application where
<code>main()</code> takes care of such initialization.
It may be hard if ICU is shipped with
another shared library (such as the Xerces-C++ XML parser)
which does not control <code>main()</code>.<br />
See the <a href="http://userguide.icu-project.org/icudata">User Guide ICU Data</a>
chapter for more details.<br />
If possible, we recommend building the .dat package.
Specify <code>--with-data-packaging=archive</code>
on the configure command line, as in<br />
<code>runConfigureICU Linux --with-data-packaging=archive</code><br />
(Read the configure script's output for further instructions.
On Windows, the Visual Studio build generates both the .dat package
and the data DLL.)<br />
Be sure to install and use the tiny stubdata library
rather than the large data DLL.</li>
<li><b>Static libraries:</b> It may make sense to build the ICU code
into static libraries (.a) rather than shared libraries (.so/.dll).
Static linking reduces the overall size of the binary by removing
code that is never called.<br />
Example configure command line:<br />
<code>runConfigureICU Linux --enable-static --disable-shared</code></li>
<li><b>Out-of-source build:</b> It is usually desirable to keep the ICU
source file tree clean and have build output files written to
a different location. This is called an "out-of-source build".
Simply invoke the configure script from the target location:
<pre>~/icu$ svn export http://source.icu-project.org/repos/icu/icu/trunk
~/icu$ mkdir trunk-dev
~/icu$ cd trunk-dev
~/icu/trunk-dev$ ../trunk/source/runConfigureICU Linux
~/icu/trunk-dev$ make check</pre></li>
</ul>
<h4>ICU as a System-Level Library</h4>
<p>If ICU is installed as a system-level library, there are further
opportunities and restrictions to consider.
For details, see the <em>Using ICU as an Operating System Level Library</em>
section of the <a href="http://userguide.icu-project.org/design">User Guide ICU Architectural Design</a> chapter.</p>
<ul>
<li><b>Data path:</b> For a system-level library, it is best to load
ICU data from the .dat package file because the file system path
to the .dat package file can be hardcoded. ICU will automatically set
the path to the final install location using U_ICU_DATA_DEFAULT_DIR.
Alternatively, you can set <code>-DICU_DATA_DIR=/path/to/icu/data</code>
when building the ICU code. (Used by source/common/putil.c.)<br />
Consider also setting <code>-DICU_NO_USER_DATA_OVERRIDE</code>
if you do not want the "ICU_DATA" environment variable to be used.
(An application can still override the data path via
<code>u_setDataDirectory()</code> or
<code>udata_setCommonData()</code>.</li>
<li><b>Hide draft API:</b> API marked with <code>@draft</code>
is new and not yet stable. Applications must not rely on unstable
APIs from a system-level library.
Define <code>U_HIDE_DRAFT_API</code>, <code>U_HIDE_INTERNAL_API</code>
and <code>U_HIDE_SYSTEM_API</code>
by modifying unicode/utypes.h before installing it.</li>
<li><b>Only C APIs:</b> Applications must not rely on C++ APIs from a
system-level library because binary C++ compatibility
across library and compiler versions is very hard to achieve.
Most ICU C++ APIs are in header files that contain a comment with
<code>\brief C++ API</code>.
Consider not installing these header files.</li>
<li><b>Disable renaming:</b> By default, ICU library entry point names
have an ICU version suffix. Turn this off for a system-level installation,
to enable upgrading ICU without breaking applications. For example:<br />
<code>runConfigureICU Linux --disable-renaming</code><br />
The public header files from this configuration must be installed
for applications to include and get the correct entry point names.</li>
</ul>
<h3><a name="UserConfig" href="#UserConfig" id="UserConfig">User-Configurable Settings</a></h3>
<p>ICU4C can be customized via a number of user-configurable settings.
Many of them are controlled by preprocessor macros which are
defined in the <code>source/common/unicode/uconfig.h</code> header file.
Some turn off parts of ICU, for example conversion or collation,
trading off a smaller library for reduced functionality.
Other settings are recommended (see previous section)
but their default values are set for better source code compatibility.</p>
<p>In order to change such user-configurable settings, you can
either modify the <code>uconfig.h</code> header file by adding
a specific <code>#define ...</code> for one or more of the macros
before they are first tested,
or set the compiler's preprocessor flags (<code>CPPFLAGS</code>) to include
an equivalent <code>-D</code> macro definition.</p>
<h3><a name="HowToBuildWindows" href="#HowToBuildWindows" id=
"HowToBuildWindows">How To Build And Install On Windows</a></h3>
<p>Building International Components for Unicode requires:</p>
<ul>
<li>Microsoft Windows</li>
<li>Microsoft Visual C++ (see the ICU download page for the currently compatible version)</li>
<li>NOTE: <a href="#HowToBuildCygwin">Cygwin</a> is required if using a version of MSVC other than the one
compatible with the supplied project files or if other compilers are used to build ICU. (e.g. GCC)</li>
</ul>
<p>The steps are:</p>
<ol>
<li>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.</li>
<li>Be sure that the ICU binary directory, <i><ICU></i>\bin\, is
included in the <strong>PATH</strong> environment variable. The tests will
not work without the location of the ICU DLL files in the path.</li>
<li>Open the "<i><ICU></i>\source\allinone\allinone.sln" workspace
file in Microsoft Visual Studio. (This solution includes all the
International Components for Unicode libraries, necessary ICU building
tools, and the test suite projects). Please see the <a href=
"#HowToBuildWindowsCommandLine">command line note below</a> if you want to
build from the command line instead.</li>
<li>Set the active platform to "Win32" or "x64" (See <a href="#HowToBuildWindowsPlatform">Windows platform note</a> below)
and configuration to "Debug" or "Release" (See <a href="#HowToBuildWindowsConfig">Windows configuration note</a> below).</li>
<li>Choose the "Build" menu and select "Rebuild Solution". If you want to
build the Debug and Release at the same time, see the <a href=
"#HowToBuildWindowsBatch">batch configuration note</a> below.</li>
<li>Run the tests. They can be run from the command line or from within Visual Studio.
<h4>Running the Tests from the Windows Command Line (cmd)</h4>
<ul>
<li>For x86 (32 bit) and Debug, use: <br />
<tt><i><ICU></i>\source\allinone\icucheck.bat <i>Platform</i> <i>Configuration</i>
</tt> <br />
</li>
<li>So, for example:
<br />
<tt><i><ICU></i>\source\allinone\icucheck.bat <b>x86</b> <b>Debug</b>
</tt>
<br/> or <br />
<tt><i><ICU></i>\source\allinone\icucheck.bat <b>x86</b> <b>Release</b>
</tt>
<br/> or <br />
<tt><i><ICU></i>\source\allinone\icucheck.bat <b>x64</b> <b>Release</b>
</tt></li>
</ul>
<h4>Running the Tests from within Visual Studio</h4>
<ol>
<li>Run the C++ test suite, "intltest". To do this: set the active startup
project to "intltest", and press Ctrl+F5 to run it. Make sure that it
passes without any errors.</li>
<li>Run the C test suite, "cintltst". To do this: set the active startup
project to "cintltst", and press Ctrl+F5 to run it. Make sure that it
passes without any errors.</li>
<li>Run the I/O test suite, "iotest". To do this: set the active startup
project to "iotest", and press Ctrl+F5 to run it. Make sure that it passes
without any errors.</li>
</ol>
</li>
<li>You are now able to develop applications with ICU by using the
libraries and tools in <i><ICU></i>\bin\. The headers are in
<i><ICU></i>\include\ and the link libraries are in
<i><ICU></i>\lib\. To install the ICU runtime on a machine, or ship
it with your application, copy the needed components from
<i><ICU></i>\bin\ to a location on the system PATH or to your
application directory.</li>
</ol>
<p><a name="HowToBuildWindowsCommandLine" id=
"HowToBuildWindowsCommandLine"><strong>Using MSDEV At The Command Line
Note:</strong></a> 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, 'devenv.com
<i><ICU></i>\source\allinone\allinone.sln /build "Win32|Release"'. You can also
use Cygwin with this compiler to build ICU, and you can refer to the <a href=
"#HowToBuildCygwin">How To Build And Install On Windows with Cygwin</a>
section for more details.</p>
<p><a name="HowToBuildWindowsPlatform" id=
"HowToBuildWindowsPlatform"><strong>Setting Active Platform
Note:</strong></a> Even though you are able to select "x64" as the active platform, if your operating system is
not a 64 bit version of Windows, the build will fail. To set the active platform, two different possibilities are:</p>
<ul>
<li>Choose "Build" menu, select "Configuration Manager...", and select
"Win32" or "x64" for the Active Platform Solution.</li>
<li>Another way is to select the desired build configuration from "Solution
Platforms" dropdown menu from the standard toolbar. It will say
"Win32" or "x64" in the dropdown list.</li>
</ul>
<p><a name="HowToBuildWindowsConfig" id=
"HowToBuildWindowsConfig"><strong>Setting Active Configuration
Note:</strong></a> To set the active configuration, two different
possibilities are:</p>
<ul>
<li>Choose "Build" menu, select "Configuration Manager...", and select
"Release" or "Debug" for the Active Configuration Solution.</li>
<li>Another way is to select the desired build configuration from "Solution
Configurations" dropdown menu from the standard toolbar. It will say
"Release" or "Debug" in the dropdown list.</li>
</ul>
<p><a name="HowToBuildWindowsBatch" id="HowToBuildWindowsBatch"><strong>Batch
Configuration Note:</strong></a> If you want to build the Win32 and x64 platforms and
Debug and Release configurations at the same time, choose "Build" menu, and select "Batch
Build...". Click the "Select All" button, and then click the "Rebuild"
button.</p>
<h3><a name="HowToBuildCygwin" href="#HowToBuildCygwin" id=
"HowToBuildCygwin">How To Build And Install On Windows with Cygwin</a></h3>
<p>Building International Components for Unicode with this configuration
requires:</p>
<ul>
<li>Microsoft Windows</li>
<li>Microsoft Visual C++ (when gcc isn't used).</li>
<li>
Cygwin with the following installed:
<ul>
<li>bash</li>
<li>GNU make</li>
<li>ar</li>
<li>ranlib</li>
<li>man (if you plan to look at the man pages)</li>
</ul>
</li>
</ul>
<p>There are two ways you can build ICU with Cygwin. You can build with gcc
or Microsoft Visual C++. If you use gcc, the resulting libraries and tools
will depend on the Cygwin environment. If you use Microsoft Visual C++, the
resulting libraries and tools do not depend on Cygwin and can be more easily
distributed to other Windows computers (the generated man pages and shell
scripts still need Cygwin). To build with gcc, please follow the "<a href=
"#HowToBuildUNIX">How To Build And Install On UNIX</a>" instructions, while
you are inside a Cygwin bash shell. To build with Microsoft Visual C++,
please use the following instructions:</p>
<ol>
<li>Start the Windows "Command Prompt" window. This is different from the
gcc build, which requires the Cygwin Bash command prompt. The Microsoft
Visual C++ compiler will not work with a bash command prompt.</li>
<li>If the computer isn't set up to use Visual C++ from the command line,
you need to run vcvars32.bat.<br />For example:<br />"<tt>C:\Program Files\Microsoft
Visual Studio 8\VC\bin\vcvars32.bat</tt>" can be used for 32-bit builds
<strong>or</strong> <br />"<tt>C:\Program Files (x86)\Microsoft Visual Studio
8\VC\bin\amd64\vcvarsamd64.bat</tt>" can be used for 64-bit builds on
Windows x64.</li>
<li>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.</li>
<li>Change directory to "icu/source", which is where you unzipped ICU.</li>
<li>Run "<tt>bash <a href="source/runConfigureICU">./runConfigureICU</a>
Cygwin/MSVC</tt>" (See <a href="#HowToWindowsConfigureICU">Windows
configuration note</a> and non-functional configure options below).</li>
<li>Type <tt>"make"</tt> to compile the libraries and all the data files.
This make command should be GNU make.</li>
<li>Optionally, type <tt>"make check"</tt> to run the test suite, which
checks for ICU's functionality integrity (See <a href=
"#HowToTestWithoutGmake">testing note</a> below).</li>
<li>Type <tt>"make install"</tt> to install ICU. If you used the --prefix=
option on configure or runConfigureICU, ICU will be installed to the
directory you specified. (See <a href="#HowToInstallICU">installation
note</a> below).</li>
</ol>
<p><a name="HowToWindowsConfigureICU" id=
"HowToWindowsConfigureICU"><strong>Configuring ICU on Windows
NOTE:</strong></a> </p>
<p>
Ensure that the order of the PATH is MSVC, Cygwin, and then other PATHs. The configure
script needs certain tools in Cygwin (e.g. grep).
</p>
<p>
Also, you may need to run <tt>"dos2unix.exe"</tt> on all of the scripts (e.g. configure)
in the top source directory of ICU. To avoid this issue, you can download
the ICU source for Unix platforms (icu-xxx.tgz).
</p>
<p>In addition to the Unix <a href=
"#HowToConfigureICU">configuration note</a> the following configure options
currently do not work on Windows with Microsoft's compiler. Some options can
work by manually editing <tt>icu/source/common/unicode/pwin32.h</tt>, but
manually editing the files is not recommended.</p>
<ul>
<li><tt>--disable-renaming</tt></li>
<li><tt>--enable-tracing</tt></li>
<li><tt>--enable-rpath</tt></li>
<li><tt>--enable-static</tt> (Requires that U_STATIC_IMPLEMENTATION be
defined in user code that links against ICU's static libraries.)</li>
<li><tt>--with-data-packaging=files</tt> (The pkgdata tool currently does
not work in this mode. Manual packaging is required to use this mode.)</li>
</ul>
<h3><a name="HowToBuildUNIX" href="#HowToBuildUNIX" id="HowToBuildUNIX">How
To Build And Install On UNIX</a></h3>
<p>Building International Components for Unicode on UNIX requires:</p>
<ul>
<li>A C++ compiler installed on the target machine (for example: gcc, CC,
xlC_r, aCC, cxx, etc...).</li>
<li>An ANSI C compiler installed on the target machine (for example:
cc).</li>
<li>A recent version of GNU make (3.80+).</li>
<li>For a list of z/OS tools please view the <a href="#HowToBuildZOS">z/OS
build section</a> of this document for further details.</li>
</ul>
<p>Here are the steps to build ICU:</p>
<ol>
<li>Decompress the icu-<i>X</i>.<i>Y</i>.tgz (or
icu-<i>X</i>.<i>Y</i>.tar.gz) file. For example, <tt>"gunzip -d <
icu-<i>X</i>.<i>Y</i>.tgz | tar xvf -"</tt></li>
<li>Change directory to the "icu/source".</li>
<li>Run <span style='font-family: monospace;'>"chmod +x runConfigureICU configure install-sh"</span> because
these files may have the wrong permissions.</li>
<li>Run the <span style='font-family: monospace;'><a href="source/runConfigureICU">runConfigureICU</a></span>
script for your platform. (See <a href="#HowToConfigureICU">configuration
note</a> below).</li>
<li>Type <span style='font-family: monospace;'>"gmake"</span> (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".
<br/>