You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
ae727f8dab
#lockdown Nick.Penwarden ========================== MAJOR FEATURES + CHANGES ========================== Change 3292174 on 2017/02/08 by Nick.Shin HTML5 emscripten: wasm and webgl2 support - Linux toolchain #jira UEPLAT-1437 Switch [to] web assembly Change 3292193 on 2017/02/08 by Nick.Shin HTML5 emscripten: wasm and webgl2 support - ThirdParty libs compiled with new toolchain with wasm support #jira UEPLAT-1437 Switch [to] web assembly Change 3292215 on 2017/02/08 by Nick.Shin HTML5 emscripten: wasm and wbegl2 support - emscripten toolchain #jira UEPLAT-1437 Switch [to] web assembly Change 3292222 on 2017/02/08 by Nick.Shin HTML5 emscripten: wasm support - ENGINE changes (c# & cpp files) #jira UEPLAT-1437 Switch [to] web assembly Change 3292223 on 2017/02/08 by Nick.Shin HTML5 merge ThirdParty lib build scripts from Dev-Platform to Dev-Mobile Change 3292228 on 2017/02/08 by Nick.Shin HTML5 emscripten: webgl support - webgl patches - and a lot of UE4 patches to package HTML5 on LINUX - mostly from mozilla's jukka -- thx jukka! #jira UEPLAT-828 (4.16) Support ES3 / WebGL2 in HTML5 Change 3292285 on 2017/02/08 by Nick.Shin HTML5 emscripten: wasm and webgl2 support - Windows toolchain #jira UEPLAT-1437 Switch [to] web assembly Change 3293994 on 2017/02/09 by Nick.Shin HTML5 emscripten: wasm and webgl2 support - OSX toolchain #jira UEPLAT-1437 Switch [to] web assembly Change 3294391 on 2017/02/09 by Nick.Shin HTML5 "black box issues" revisited - jukka rewrote the window resize handler -- much cleaner and more straightforward #jira UE-36341 HTML5 - View is incorrectly drawn #jira UE-32311 Templates on Firefox/Chrome on HTML5 are not full screen during Launch On Change 3296421 on 2017/02/10 by Jack.Porter Fix landscape spline segment splitting placing when using streaming levels Change 3296587 on 2017/02/10 by Jack.Porter Additional fix for landscape spline segment splitting when using streaming levels Change 3301241 on 2017/02/14 by Mi.Wang Fixed DeviceProfileEditor bug for incorrect clamp the Texture Mip LOD size. #jira UE-36237 #rb jack.porter Change 3301387 on 2017/02/14 by Nick.Shin HTML5 emscripten: webgl support - webgl patches from mozilla's jukka + hardware instancing + glBlitFramebuffer + GL AlaphaBlendOperation #jira UEPLAT-828 (4.16) Support ES3 / WebGL2 in HTML5 Change 3301405 on 2017/02/14 by Nick.Shin HTML5 plugin fix when blueprint projects are promoted to code projects automatically. #jira UE-41710 HTML5 - Package Failure - Failed to Produce item ProjectName-OnlineSubsystemNull.bc Change 3302278 on 2017/02/14 by Omar.Rodriguez UE-36651: Mac Vulkan Android Projects crash on launch. * Glslang library has been built for Mac but flag was not updated * Set GlslangAvailable to true for Mac when building an Android project with vulkan #jira UE-36651 Change 3302773 on 2017/02/14 by Chris.Babcock Add a dropdown with some common console commands on Android (contributed by rafortis) #jira UE-40834 #PR #3143 #ue4 #android Change 3305604 on 2017/02/16 by Nick.Shin HTML5 webgl2 shader- turn on: instance static mesh vertex factory #jira UEPLAT-828 (4.16) Support ES3 / WebGL2 in HTML5 Change 3308154 on 2017/02/16 by Nick.Shin HTML5 GitHub PR #jira UE-42019 GitHub 3258 : Added suport for emscripten --pre-js and --post-js option when building for HTML5 Change 3308510 on 2017/02/16 by Nick.Shin HTML5 webgl2 shader fixes #jria UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3308971 on 2017/02/17 by Jack.Porter Fix for landscape painting when height<0 in the Ortho viewports Change 3309075 on 2017/02/17 by Allan.Bentham Include static subject meshes when masking out modulated shadow casters. #jira UE-41581 Change 3309531 on 2017/02/17 by Chris.Babcock Handle large OBB files in APK #jira UE-41443 #ue4 #android Change 3311320 on 2017/02/19 by Dmitriy.Dyomin Fixed: Particle Cutout Crashes On Mobile Devices That Don't Support Hardware Instancing (Mali-400 GPU) #jira UE-41970 Change 3311347 on 2017/02/20 by Dmitriy.Dyomin Fixed: Engine Crashes When Previewing ES3_1 With Material Using World Position Offset (Need Custom Stencil) #jira UE-41976 Change 3311398 on 2017/02/20 by Dmitriy.Dyomin Fixed: Landscapes do not render on PowerVR device #jira UE-35530 Change 3311428 on 2017/02/20 by Dmitriy.Dyomin Fixed: Exposure Is More Extreme In High-End Mobile Preview Modes #jira UE-42036 Change 3311448 on 2017/02/20 by Dmitriy.Dyomin Fixed: Packaged game Crashes on android after entering "Help" command twice #jira UE-41956 Change 3311587 on 2017/02/20 by Allan.Bentham ES2 GLSL - Silently swap all uint to ints #jira UE-41548 Change 3313930 on 2017/02/21 by Allan.Bentham Print literal uints as ints when generating ES2 code. #jira UE-41548 Change 3317924 on 2017/02/22 by Nick.Shin HTML5 emscripten: wasm & webgl2 support - RC1 - Linux toolchain #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3317929 on 2017/02/22 by Nick.Shin HTML5 emscripten: wasm & webgl2 support - RC1 - ThirdParty libs compiled with new toolchain with wasm and webgl2 support #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3317951 on 2017/02/22 by Nick.Shin HTML5 emscripten: wasm & webgl2 support - RC1 - emscripten toolchain WARNING: emscripten/incoming/source/include/libc/bit (the file) might need to be deleted first #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3318004 on 2017/02/22 by Nick.Shin HTML5 emscripten: wasm & webgl2 support - RC1 - windows toolchain #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3318669 on 2017/02/23 by Nick.Shin HTML5 emscripten: wasm & webgl2 support - RC1 - OSX toolchain #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3318672 on 2017/02/23 by Nick.Shin HTML5 webgl2 shader fixes #jria UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3318819 on 2017/02/23 by Dmitriy.Dyomin Fixed: Rendering artifacts with bloom on iPhone7 Metal #jira UE-40978 Change 3319702 on 2017/02/23 by Chris.Babcock Disable eglSwapInterval since it can cause issues with some drivers #ue4 #android Change 3320880 on 2017/02/24 by Dmitriy.Dyomin Added r.Mobile.TonemapperFilm cvar which can be used to enable/disable filmic tonemapper on mobile, independently from desktop (disabled by default) #jira UEMOB-195 Change 3321042 on 2017/02/24 by Jack.Porter Fixed incorrect sizeof in Vulkan pipleine cache pointed out here: http://coconutlizard.co.uk/blog/ue4/ue4-its-a-size-jim/ #code_review: rolando.caloca Change 3322383 on 2017/02/24 by Chris.Babcock Fix issue with ad banner on Android 7.0 devices #jira UE-42390 #ue4 #android Change 3322479 on 2017/02/24 by Omar.Rodriguez UEMOB-199 - WEX: Improved virtual keyboard for Android * Calculating the area covered by the virtual keyboard * Calling OnVirtualKeyboardShown and OnVirtualKeyboardHidden events * Passing the Rect of the area covered by the virtual keyboard OnVirtualKeyboardShown event #jira UEMOB-199 Change 3323353 on 2017/02/27 by Allan.Bentham Fix broken mobile scene captures when !mobileHDR and RHINeedsToSwitchVerticalAxis #jira UE-42191 Change 3323431 on 2017/02/27 by Allan.Bentham CIS fix Change 3323687 on 2017/02/27 by Allan.Bentham Disable GRHINeedsUnatlasedCSMDepthsWorkaround for mobile devices. #jira UE-42131 Change 3324652 on 2017/02/28 by Dmitriy.Dyomin Fixed: Canvas elements appear darker on iOS Metal Change 3324885 on 2017/02/28 by Jack.Porter Fixed "Minimum iOS Version" setting display name #jira UE-42270 Change 3324899 on 2017/02/28 by Jack.Porter GitHub 3063 : removed duplicate gc.MaxObjectsInGame setting in IOSEngine.ini #jira UE-40018 #3063 Change 3324932 on 2017/02/28 by Jack.Porter GitHub 3257 : iPhonePackager errors in output log when opening project settings on Windows #jira UE-41984 #3257 #codereview: Peter.Sauerbrei Change 3324956 on 2017/02/28 by Jack.Porter FOpenGLFrontend::GetMaxSamplers incorrect for IOS #jira UE-42038 #3264 Change 3325478 on 2017/02/28 by Allan.Bentham PR # 3188 : Fix far distance bug with cascaded shadows on mobile (Metal) and PC mobile preview (Contributed by ufna) #jira UE-41442 Change 3327300 on 2017/03/01 by Allan.Bentham PR #3175 : Fixes high quality reflection blending seams (Contributed by kallehamalainen) #jira UE-41257 Change 3328917 on 2017/03/02 by Nick.Shin HTML5 project settings expose ini settings to edtior HTML5 project settings panel #jira UE-42331 Project Settings - HTML5 SDK - HTML Device population should be moved to an .ini #jira UE-41584 Editor locks up when adding an element for HTML5 devices on Mac #jira UE-41701 Editor freezes when setting browser filepath for inserted element in project settings Change 3329169 on 2017/03/02 by Allan.Bentham increase render thread timeout to 1 minute for suntemple / android. Prevents low end devices timing out during load. #jira UE-40696 Change 3330849 on 2017/03/02 by Nick.Shin HTML5 project settings expose ini settings to edtior HTML5 project settings panel #jira UE-42331 Project Settings - HTML5 SDK - HTML Device population should be moved to an .ini Change 3331078 on 2017/03/03 by Dmitriy.Dyomin Fixed: Device output log partial lines integrated from WEX (3250488) Change 3331112 on 2017/03/03 by Dmitriy.Dyomin Reduced state setup for slate draw calls (saves about 4ms RT time on mobile) integrated from WEX (3256584) Change 3331117 on 2017/03/03 by Dmitriy.Dyomin Fixed redundant blend state changes in opengl integrated from WEX (3256586) Change 3331173 on 2017/03/03 by Dmitriy.Dyomin Slate pixel shaders will use half precision where possible on mobile integrated from WEX (3256656) Change 3332865 on 2017/03/06 by Dmitriy.Dyomin Better MobileContentScaleFactor defaults for iOS devices #jira UEMOB-330 Change3333129on 2017/03/06 by Peter.Sauerbrei move to Library/Caches instead of documents for saved files re-enable iterative deploy on TVOS #jira UEMOB-284 Change 3334692 on 2017/03/06 by Jack.Porter Allow r.MobileContentScaleFactor to be changed at runtime on Android #jira UEMOB-173 Change 3336255 on 2017/03/07 by Nick.Shin HTML5 project settings marking SIMD and multithreading as experimental - these do not play nice with WASM builds currently... #jira UE-42331 Project Settings - HTML5 SDK - HTML Device population should be moved to an .ini Change 3337094 on 2017/03/08 by Nick.Shin HTML5 project settings marking SIMD and multithreading as experimental - these do not play nice with WASM builds currently... #jira UE-42331 Project Settings - HTML5 SDK - HTML Device population should be moved to an .ini Change 3338800 on 2017/03/08 by Chris.Babcock Update AAR handling to deal with versioning, subproject dependencies for resources, and scope #jira UE-42677 #ue4 #android Change 3338813 on 2017/03/08 by Chris.Babcock Pass build configuration to UPL for access during packaging as $S(Configuration) #jira UE-42678 #ue4 #android #ios Change 3339401 on 2017/03/09 by Alicia.Cano Android runtime permissions - Fix for WRITE_EXTERNAL_STORAGE if it is not granted at time of onCreate for non-shipping builds - Fix for Location Services - Fix for if target sdk is not set to 23+ #jira UE-38512 #android #rb: chris.babcock Change 3340736 on 2017/03/09 by Chris.Babcock Implement support for new controllers (Xbox Wireless, SteelSeries Stratus XL, PS4) (contributed by TRS-justing) #jira UE-41965 #PR #3254 #ue4 #android Change 3340744 on 2017/03/09 by Jack.Porter Expose Custom Depth to Foliage #jira UE-6061 Change 3340849 on 2017/03/09 by Dmitriy.Dyomin Fixed: iOS movie become laggy and crashes when played in iPhone 6/6s. #jira UE-42351 Change 3341268 on 2017/03/10 by Alicia.Cano PR #2894: Initial VoiceModuleAndroid support. (Contributed by devbm) #jira UE-37945 #android #rb: chris.babcock, jack.porter Change 3341303 on 2017/03/10 by Allan.Bentham Remove optimisation that prevents full specular occulsion on mobile. PR #3186 : Specular can't be blocked on high-end mobile. #jira UE-41393 Change 3342304 on 2017/03/10 by Alicia.Cano build fix #rb: chris.babcock Change 3343344 on 2017/03/13 by Alicia.Cano build fix #rb: chris.babcock Change 3343591 on 2017/03/13 by Brent.Pease iOS multiplayer fix part 1. Correct byte ordering. #jira UE-34875 Change 3343669 on 2017/03/13 by Chris.Babcock Update carefullyredist script version #jira UE-42832 Change 3344212 on 2017/03/13 by Will.Fissler Various compile fixes for Xcode 8.3. These fixes must also be added to //UE4/Release-4.15. #jira UE-41313 Change 3344396 on 2017/03/13 by Chris.Babcock Fix Java 1.5 obsolete warnings #jira UE-42851 #ue4 #android Change 3345132 on 2017/03/14 by Will.Fissler Added ifdef wrapper to check clang version for presentDrawable. Change 3345336 on 2017/03/14 by Will.Fissler Moved #if (__clang_major__ > 8) || (__clang_major__ == 8 && __clang_minor__ >= 1) check inside of the presentDrawable method. Change 3345460 on 2017/03/14 by Will.Fissler ifdef changes for presentDrawable. The last submission duped the changes, instead of merging. #rb none Change 3346046 on 2017/03/14 by Will.Fissler Fixed MetalCommandBuffer.cpp [again] after last submission duped changes instead of merging. Change 3346367 on 2017/03/14 by Chris.Babcock Fix issue with GoogleVR ARMv7 libraries included for other architectures in link #ue4 #android Change 3347682 on 2017/03/15 by Allan.Bentham Enable HW sRGB correction with retainer widget's render target. Use slate's gamma correction for mobile (where no such support exists) Render retainer box RT content with gamma correction. #jira UE-40967 Change 3348712 on 2017/03/15 by Nick.Shin HTML5 - upload to S3 updated to AWS "signature version 4" authentication #jira UE-42525 HTML5 Upload to Amazon S3 fails with Incorrect Configuration error Change 3349254 on 2017/03/16 by Jack.Porter Fix for crash using the mobile previewer when the LQ lightmap shader permutation is disabled. #jira UE-42971 Change 3349739 on 2017/03/16 by Nick.Shin HTML5 - upload to S3 better error message feedback on upload failures #jira UE-42525 HTML5 Upload to Amazon S3 fails with Incorrect Configuration error Change 3349765 on 2017/03/16 by Alicia.Cano Disable mouseover events in Mobile Previewer #jira UE-19903 #mobile #rb: Jack.Porter Change 3350049 on 2017/03/16 by Nick.Shin HTML5 - upload to S3 folder in bucket is optional #jira UE-42525 HTML5 Upload to Amazon S3 fails with Incorrect Configuration error Change 3350153 on 2017/03/16 by Nick.Shin HTML5 - upload to S3 updated S3 public link generator #jira UE-42525 HTML5 Upload to Amazon S3 fails with Incorrect Configuration error Change 3351582 on 2017/03/17 by Will.Fissler Reverting the attempted fix for Xcode 8.3: Result += " -mcpu=cortex-a9"; Currently we cannot build arm64 for iOS with this change. Change 3352085 on 2017/03/17 by Alicia.Cano iOS doesn't honor request to close the virtual keyboard leading to a crash #jira UE-36447 #ios #rb:Peter.Sauerbrei Change 3353313 on 2017/03/19 by Ben.Marsh Always allow large *.js files in Github. Change 3354444 on 2017/03/20 by Nick.Shin HTML5 - upload to S3 to help make it obvious that "upload to S3" checkbox is set/or not -- disable S3 details if checkbox for "uploading to S3" is not set #jira UE-42525 HTML5 Upload to Amazon S3 fails with Incorrect Configuration error Change 3355618 on 2017/03/20 by Nick.Shin HTML5 Save Game System - ripped out HTML5 code [from Engine's SaveGameSystem.h] and placed it in HTML5Platform.cpp - cleaned up HTML5PlatformFile.cpp (make it match as clost to linux's version) - created HTML5's own PlatformFeature & SaveGameSystem files -- and updated HTML5PlatformMisc to make use of the the new HTML5 SaveGame code #jira UE-42081 Remove heinous HTML5 code from engine Change 3355621 on 2017/03/20 by Nick.Shin remove temp debugging code #jira UE-42081 Remove heinous HTML5 code from engine Change 3356937 on 2017/03/21 by Chris.Babcock Add "stat vulkanrhi" to new console dropdown #jira UE-43149 #ue4 #android Change 3357652 on 2017/03/21 by Nick.Shin HTML5 performance speed ups added "use fixed timestep" setting option for HTML5 builds (this has been separated from Engine - General Settings - Framerate) - this is slightly different to smooth framerate and fixed framerate - thus, the timestep option was put in the HTML5 specific panel this option is based on the suggestions by jukka's post: - https://answers.unrealengine.com/questions/409629/smooth-frame-rate-and-use-fixed-frame-rate-should.html however, using this option will make the player "run faster" on (for example) thirdperson blueprint template -- but, it has no effect on other (for example) zen garden... #jira UE-30214 - Implement a warning message for fps settings Change 3360415 on 2017/03/23 by Allan.Bentham Fix crash that occurs when ES3.1 preview is used with r.MobileHDR32bppMode modes. Change 3360418 on 2017/03/23 by Allan.Bentham Disable filmic tonemapper if r.MobileHDR32bppMode is in use. #jira UE-40913 Change 3360557 on 2017/03/23 by Allan.Bentham Better fix for mobile CSM shadow flickering (UE-42131), now works for PC OpenGL based mobile preview. #jira UE-42131 Change 3362258 on 2017/03/23 by Dmitriy.Dyomin Fixed: Canvas texture element gamma issues on iOS Metal Change 3362321 on 2017/03/24 by Dmitriy.Dyomin GitHub 3173 : MaterialAO support for mobile rendering path (contributed by kallehamalainen) #3173 Change 3363550 on 2017/03/24 by Alicia.Cano build fix for devices < Android 5.0 #jira UE-43299 #android #rb: chris.babcock Change 3363687 on 2017/03/24 by Chris.Babcock Fix Android password hiding in input dialog #jira WEX-5159 #ue4 #android Change 3365280 on 2017/03/27 by Dmitriy.Dyomin Fix for GL_EXT_shader_framebuffer_fetch on Zenfone5. Use UE_EXT_shader_framebuffer_fetch define on all devices to enable extension Change 3365291 on 2017/03/27 by Dmitriy.Dyomin Copied form WEX CL# 3308653 Fixed: Enabling shader cache causes crash on NVIDIA Shield #jira UE-41639 Change 3365293 on 2017/03/27 by Dmitriy.Dyomin GitHub 3411 : Fix crash in patching utils mount method (contributed by nverenik) #jira UE-43247 #3411 Change 3365340 on 2017/03/27 by Dmitriy.Dyomin Fixed: Moving sublevel in world composition browser does not appear in Undo History #jira UE-35535 Change 3365564 on 2017/03/27 by Allan.Bentham SkyLightComponent now serializes IrradianceMap SH values. clicking Recapture sky button in mobile preview switches back to SM4/5 to update captures. Skylights that are dirty from load will trigger reflection capture update once shaders are rebuilt. #jira UE-42436 Change 3366282 on 2017/03/27 by Nick.Shin remove dead links these files to not exist anywhere in the make-3.81 subfolders #UDN-354501 #jira none Change 3366306 on 2017/03/27 by Nick.Shin HTML5 - disable multi-threading for wasm #jira UE-43219 - HTML5 disable multi-threading for wasm Change 3366307 on 2017/03/27 by Nick.Shin HTML5 packaging Shipping builds big cleanup / additions to *gz file support for amazon s3 * both, uploading to s3 * and allowing s3 to host the games there #jira UE-43002 HTML5 in Shipping fails downloading symbols files #jria UE-43001 HTML5 Shipping Projects fail looking for compressed files when "Compress files during shipping packaging" is not selected. Change 3367385 on 2017/03/28 by Allan.Bentham Display skylight serialization warning only when cooking for mobile platforms. #jira UE-42436 Change 3368583 on 2017/03/28 by Chris.Babcock Expose JAVA_HOME setting in Android SDK project settings on Mac #jira UE-43418 #ue4 #android Change 3368803 on 2017/03/28 by Chris.Babcock Fix features requested in manifest for "Daydream and Cardboard" mode #jira UE-43314 #ue4 #android Change 3369087 on 2017/03/28 by Jack.Porter Changed tooltip and added supported devices in paretheses for Android Mobile Deferred / ES31+AEP #jira UE-42438 Change 3369372 on 2017/03/29 by Allan.Bentham Fix disappearing meshes when r.mobile.allowdistancefieldshadows is disabled. #jira UE-43366 Change 3369381 on 2017/03/29 by Jack.Porter Show warnings when mobile shader permutations required for rendering are disbaled Made FReadOnlyCVARCache a singleton and added mobile CVars, used for MobileBasePassRendering. #jira UE-43050 Change 3369430 on 2017/03/29 by Allan.Bentham fix CIS build Change 3369740 on 2017/03/29 by Allan.Bentham Added Android option to enable builds with hidden symbol visbility by default. (bBuildWithHiddenSymbolVisibility) Android links with -gc-sections to remove unused code/data Add JNI_METHOD for java accessible native functions, fixed up existing JNI functions to use macro. Add support for map file generation with android. Add 'bBuildWithHiddenSymbolVisibility' to AndroidPlatform.HasDefaultBuildConfig() bBuildWithHiddenSymbolVisibility defaults to false in BaseEngine.ini #jira UEMOB-168 Change 3369975 on 2017/03/29 by Nick.Shin HTML5 - AWS S3 shareable link for shipping builds corrected #jira UE-43379 Amazon S3 Shareable link does not generate correct filepath. Change 3369998 on 2017/03/29 by Nick.Shin HTML5 python build scripts PR:1cb836d43c#jira none Change 3370214 on 2017/03/29 by Nick.Shin HTML5 - default bUseFixedTimeStep to false... #jira UE-43380 - Default HTML5 gamespeed is faster than equivalent platforms Change 3370762 on 2017/03/29 by Chris.Babcock Fixes to new keyboard for Android - Ensure the local scope ScreenRect passed into OnVirtualKeyboardShown in AndroidJNI is captured by value instead of by reference. - Moved ShowVirtualKeyboardInput's bKeyboardShowing early-out checks into the UI thread task. This allows the keyboard to continue showing when changing focus between multiple EditableTextBox widgets. #ue4 #android Change 3371344 on 2017/03/30 by Jack.Porter Fixed issue where Vulkan screenshot R/B channels were reversed on Android #jira UE-43479 Change 3372926 on 2017/03/30 by Peter.Sauerbrei start the process of sunsetting 32-bit and GLES2 on iOS #jira UE-42266 Change 3372970 on 2017/03/30 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support - windows toolchain #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 #rn Change 3372989 on 2017/03/30 by Peter.Sauerbrei fix for Xcode 8.3 build with 32-bit Change 3373007 on 2017/03/30 by Peter.Sauerbrei fix for crash when online subsystem is disabled on IOS Change 3373108 on 2017/03/30 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support - emscripten toolchain WARNING: emscripten/incoming/source/include/libc/bit (the file) might need to be deleted first #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 #rn Change 3373163 on 2017/03/30 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support - OSX toolchain #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 #rn Change 3373169 on 2017/03/30 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support license file updated #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 #rnx Change 3373287 on 2017/03/30 by Nick.Shin HTML5 - 1.36.11 emscripten - remove old SDK #jira none #rnx Change 3373289 on 2017/03/30 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support - Linux toolchain #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 #rn Change 3373595 on 2017/03/30 by Chris.Babcock Reenable GooglePlay for ARM64 now that it doesn't crash #jira UE-36198 #ue4 #android Change 3373606 on 2017/03/30 by Chris.Babcock Submitting Allan's shelved EXT_shader_framebuffer_fetch fix #ue4 #android Change 3375456 on 2017/03/31 by Chris.Babcock Add missing keycodes for Android keyboard (@ and #) #jira WEX-5777 #ue4 #android Change 3376309 on 2017/04/03 by Allan.Bentham Fix overflow issues with mobile DoF. Change 3377041 on 2017/04/03 by Will.Fissler Adding Testbed content for PlatformShowcase. Change 3377582 on 2017/04/03 by Alicia.Cano adding back in GET_ACCOUNTS permission as it is required for Reset Achievements #jira: UE-43265 #android #rb: Chris.Babcock Change 3377643 on 2017/04/03 by Peter.Sauerbrei fix for memory leak in MallocBinned #jira UE-43008 Change 3378033 on 2017/04/04 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support - ThirdParty libs compiled with new toolchain with wasm and webgl2 support #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 #rn Change 3378034 on 2017/04/04 by Nick.Shin HTML5 - 1.37.9 emscripten: wasm & webgl2 support - ThirdParty build scripts #jira UEMOB-263 Switch [to] web assembly #jira UEMOB-201 Support ES3 / WebGL2 in HTML5 Change 3378035 on 2017/04/04 by Nick.Shin HTML5 - Update GameX template to make it work with trunk Emscripten PRdc2b26f452 (commitcomment-21454978)#jira none #rn Change 3378044 on 2017/04/04 by Nick.Shin HTML5 harfbuzz - double checking recompiled with NO multithreading wasm currently does not support pthreads *** THIS IS STILL WIP *** checking in to match 3rd party libs compiled configuration #jira UE-28588 - Build HarfBuzz for HTML5 #rnx Change 3378264 on 2017/04/04 by Allan.Bentham Fix crash when using consolas font on android sdk 24 #jira UE-43464 Change 3379097 on 2017/04/04 by Nick.Shin CIS HTML5 build warning fix #jria none #rnx Change 3379333 on 2017/04/04 by Chris.Babcock Prevent inserting extra permissions into manifest multiple times #jira UE-43583 #ue4 #android Change 3380870 on 2017/04/05 by Chris.Babcock Fix merge issue Change 3380898 on 2017/04/05 by Chris.Babcock Fixed again Change 3381443 on 2017/04/05 by Chris.Babcock Fix for GearVR non-unity build #ue4 #android Change 3381941 on 2017/04/05 by Chris.Babcock Fix HTTPChunkInstaller texture format checks and missing #define warning #jira UE-43706 #ue4 #android Change 3382056 on 2017/04/05 by Chris.Babcock Updates to Android AARs needed for Facebook plugin Change 3382097 on 2017/04/05 by Chris.Babcock Disable java console cmd receiver only in shipping builds #jira UE-43710 #ue4 #android Change 3382497 on 2017/04/06 by Allan.Bentham Fix Fortnite Cooked Server crashes when joining game from lobby. #jira UE-43695 Change 3383227 on 2017/04/06 by Will.Fissler Reverted case sensitive change, from yesterday, and implemented a pragma instead. #jira UE-41313 [CL 3383473 by Jack Porter in Main branch]
<!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/>
Note that the compilation command output may be simplified on your platform. If this is the case, you will see just:
<blockquote><p style='background-color: #ddd; font-family: monospace; font-size: small'>gcc ... stubdata.c</p></blockquote>
rather than
<blockquote><p style='background-color: #ddd; font-family: monospace; font-size: small'>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</p></blockquote>
.<br/>
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.
</li>
<li>Optionally, type <span style='font-family: monospace;'>"gmake check"</span> to run the test suite, which
checks for ICU's functionality integrity (See <a href=
"#HowToTestWithoutGmake">testing note</a> below).</li>
<li>Type <span style='font-family: monospace;'>"gmake install"</span> 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="HowToConfigureICU" id="HowToConfigureICU"><strong>Configuring ICU
NOTE:</strong></a> Type <tt>"./runConfigureICU --help"</tt> for help on how
to run it and a list of supported platforms. You may also want to type
<tt>"./configure --help"</tt> to print the available configure options that
you may want to give runConfigureICU. If you are not using the
runConfigureICU script, or your platform is not supported by the script, you
may need to set your CC, CXX, CFLAGS and CXXFLAGS environment variables, and
type <tt>"./configure"</tt>.
HP-UX users, please see this <a href="#ImportantNotesHPUX">note regarding
HP-UX multithreaded build issues</a> with newer compilers. Solaris users,
please see this <a href="#ImportantNotesSolaris">note regarding Solaris
multithreaded build issues</a>.</p>
<p>ICU is built with strict compiler warnings enabled by default. If this
causes excessive numbers of warnings on your platform, use the --disable-strict
option to configure to reduce the warning level.</p>
<p><a name="HowToTestWithoutGmake" id="HowToTestWithoutGmake"><strong>Running
The Tests From The Command Line NOTE:</strong></a> You may have to set
certain variables if you with to run test programs individually, that is
apart from "gmake check". The environment variable <strong>ICU_DATA</strong>
can be set to the full pathname of the data directory to indicate where the
locale data files and conversion mapping tables are when you are not using
the shared library (e.g. by using the .dat archive or the individual data
files). The trailing "/" is required after the directory name (e.g.
"$Root/source/data/out/" will work, but the value "$Root/source/data/out" is
not acceptable). You do not need to set <strong>ICU_DATA</strong> if the
complete shared data library is in your library path.</p>
<p><a name="HowToInstallICU" id="HowToInstallICU"><strong>Installing ICU
NOTE:</strong></a> Some platforms use package management tools to control the
installation and uninstallation of files on the system, as well as the
integrity of the system configuration. You may want to check if ICU can be
packaged for your package management tools by looking into the "packaging"
directory. (Please note that if you are using a snapshot of ICU from Subversion, it
is probable that the packaging scripts or related files are not up to date
with the contents of ICU at this time, so use them with caution).</p>
<h3><a name="HowToBuildZOS" href="#HowToBuildZOS" id="HowToBuildZOS">How To
Build And Install On z/OS (OS/390)</a></h3>
<p>You can install ICU on z/OS or OS/390 (the previous name of z/OS), but IBM
tests only the z/OS installation. You install ICU in a z/OS UNIX system
services file system such as HFS or zFS. On this platform, it is important
that you understand a few details:</p>
<ul>
<li>The makedep and GNU make tools are required for building ICU. If it
is not already installed on your system, it is available at the <a href=
"http://www-03.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html">z/OS UNIX -
Tools and Toys</a> site. The PATH environment variable should be updated to
contain the location of this executable prior to build. Failure to add these
tools to your PATH will cause ICU build failures or cause pkgdata to fail
to run.</li>
<li>Since USS does not support using the mmap() function over NFS, it is
recommended that you build ICU on a local filesystem. Once ICU has been
built, you should not have this problem while using ICU when the data
library has been built as a shared library, which is this is the default
setting.</li>
<li>Encoding considerations: The source code assumes that it is compiled
with codepage ibm-1047 (to be exact, the UNIX System Services variant of
it). The pax command converts all of the source code files from ASCII to
codepage ibm-1047 (USS) EBCDIC. However, some files are binary files and
must not be converted, or must be converted back to their original state.
You can use the <a href="as_is/os390/unpax-icu.sh">unpax-icu.sh</a> script
to do this for you automatically. It will unpackage the tar file and
convert all the necessary files for you automatically.</li>
<li>z/OS supports both native S/390 hexadecimal floating point and (with
OS/390 2.6 and later) IEEE 754 binary floating point. This is a compile
time option. Applications built with IEEE should use ICU DLLs that are
built with IEEE (and vice versa). The environment variable IEEE390=0 will
cause the z/OS version of ICU to be built without IEEE floating point
support and use the native hexadecimal floating point. By default ICU is
built with IEEE 754 support. Native floating point support is sufficient
for codepage conversion, resource bundle and UnicodeString operations, but
the Format APIs require IEEE binary floating point.</li>
<li>z/OS introduced the concept of Extra Performance Linkage (XPLINK) to
bring performance improvement opportunities to call-intensive C and C++
applications such as ICU. XPLINK is enabled on a DLL-by-DLL basis, so if
you are considering using XPLINK in your application that uses ICU, you
should consider building the XPLINK-enabled version of ICU. You need to
set ICU's environment variable <code>OS390_XPLINK=1</code> prior to
invoking the make process to produce binaries that are enabled for
XPLINK. The XPLINK option, which is available for z/OS 1.2 and later,
requires the PTF PQ69418 to build XPLINK enabled binaries.</li>
<li>ICU requires XPLINK for the icuio library. If you want to use the
rest of ICU without XPLINK, then you must use the --disable-icuio
configure option.</li>
<li>The latest versions of z/OS use <a
href="http://www.ibm.com/support/docview.wss?uid=swg2120240">XPLINK
version (C128) of the C++ standard library</a> by default. You may see <a
href="http://www.ibm.com/support/docview.wss?uid=swg21376279">an
error</a> when running with XPLINK disabled. To avoid this error,
set the following environment variable or similar:
<pre><samp>export _CXX_PSYSIX="CEE.SCEELIB(C128N)":"CBC.SCLBSID(IOSTREAM,COMPLEX)"</samp></pre>
</li>
<li>When building ICU data, the heap size may need to be increased with the following
environment variable:
<pre><samp>export _CEE_RUNOPTS="HEAPPOOLS(ON),HEAP(4M,1M,ANY,FREE,0K,4080)"</samp></pre>
</li>
<li>The rest of the instructions for building and testing ICU on z/OS with
UNIX System Services are the same as the <a href="#HowToBuildUNIX">How To
Build And Install On UNIX</a> section.</li>
</ul>
<h4>z/OS (Batch/PDS) support outside the UNIX system services
environment</h4>
<p>By default, ICU builds its libraries into the UNIX file system (HFS). In
addition, there is a z/OS specific environment variable (OS390BATCH) to build
some libraries into the z/OS native file system. This is useful, for example,
when your application is externalized via Job Control Language (JCL).</p>
<p>The OS390BATCH environment variable enables non-UNIX support including the
batch environment. When OS390BATCH is set, the libicui18n<i>XX</i>.dll,
libicuuc<i>XX</i>.dll, and libicudt<i>XX</i>e.dll binaries are built into
data sets (the native file system). Turning on OS390BATCH does not turn off
the normal z/OS UNIX build. This means that the z/OS UNIX (HFS) DLLs will
always be created.</p>
<p>Two additional environment variables indicate the names of the z/OS data
sets to use. The LOADMOD environment variable identifies the name of the data
set that contains the dynamic link libraries (DLLs) and the LOADEXP
environment variable identifies the name of the data set that contains the
side decks, which are normally the files with the .x suffix in the UNIX file
system.</p>
<p>A data set is roughly equivalent to a UNIX or Windows file. For most kinds
of data sets the operating system maintains record boundaries. UNIX and
Windows files are byte streams. Two kinds of data sets are PDS and PDSE. Each
data set of these two types contains a directory. It is like a UNIX
directory. Each "file" is called a "member". Each member name is limited to
eight bytes, normally EBCDIC.</p>
<p>Here is an example of some environment variables that you can set prior to
building ICU:</p>
<pre>
<samp>OS390BATCH=1
LOADMOD=<i>USER</i>.ICU.LOAD
LOADEXP=<i>USER</i>.ICU.EXP</samp>
</pre>
<p>The PDS member names for the DLL file names are as follows:</p>
<pre>
<samp>IXMI<i>XX</i>IN --> libicui18n<i>XX</i>.dll
IXMI<i>XX</i>UC --> libicuuc<i>XX</i>.dll
IXMI<i>XX</i>DA --> libicudt<i>XX</i>e.dll</samp>
</pre>
<p>You should point the LOADMOD environment variable at a partitioned data
set extended (PDSE) and point the LOADEXP environment variable at a
partitioned data set (PDS). The PDSE can be allocated with the following
attributes:</p>
<pre>
<samp>Data Set Name . . . : <i>USER</i>.ICU.LOAD
Management class. . : <i>**None**</i>
Storage class . . . : <i>BASE</i>
Volume serial . . . : <i>TSO007</i>
Device type . . . . : <i>3390</i>
Data class. . . . . : <i>LOAD</i>
Organization . . . : PO
Record format . . . : U
Record length . . . : 0
Block size . . . . : <i>32760</i>
1st extent cylinders: 1
Secondary cylinders : 5
Data set name type : LIBRARY</samp>
</pre>
<p>The PDS can be allocated with the following attributes:</p>
<pre>
<samp>Data Set Name . . . : <i>USER</i>.ICU.EXP
Management class. . : <i>**None**</i>
Storage class . . . : <i>BASE</i>
Volume serial . . . : <i>TSO007</i>
Device type . . . . : <i>3390</i>
Data class. . . . . : <i>**None**</i>
Organization . . . : PO
Record format . . . : FB
Record length . . . : 80
Block size . . . . : <i>3200</i>
1st extent cylinders: 3
Secondary cylinders : 3
Data set name type : PDS</samp>
</pre>
<h3><a name="HowToBuildOS400" href="#HowToBuildOS400" id=
"HowToBuildOS400">How To Build And Install On The IBM i Family (IBM i, i5/OS OS/400)</a></h3>
<p>Before you start building ICU, ICU requires the following:</p>
<ul>
<li>QSHELL interpreter installed (install base option 30, operating system)
<!--li>QShell Utilities, PRPQ 5799-XEH (not required for V4R5)</li--></li>
<li>ILE C/C++ Compiler installed on the system</li>
<li>The latest IBM tools for Developers for IBM i —
<a href='http://www.ibm.com/servers/enable/site/porting/tools/'>http://www.ibm.com/servers/enable/site/porting/tools/</a>
<!-- formerly: http://www.ibm.com/servers/enable/site/porting/iseries/overview/gnu_utilities.html -->
</li>
</ul>
<p>The following describes how to setup and build ICU. For background
information, you should look at the <a href="#HowToBuildUNIX">UNIX build
instructions</a>.</p>
<ol>
<li>
Copy the ICU source .tgz to the IBM i environment, as binary.
Also, copy the <a href='as_is/os400/unpax-icu.sh'>unpax-icu.sh</a> script into the same directory, as a text file.
</li>
<li>
Create target library. This library will be the target for the
resulting modules, programs and service programs. You will specify this
library on the OUTPUTDIR environment variable.
<pre>
<samp>CRTLIB LIB(<i>libraryname</i>)
ADDENVVAR ENVVAR(OUTPUTDIR) VALUE('<i>libraryname</i>') REPLACE(*YES) </samp></pre>
</li>
<li>
Set up the following environment variables and job characteristics in your build process
<pre>
<samp>ADDENVVAR ENVVAR(MAKE) VALUE('gmake') REPLACE(*YES)
CHGJOB CCSID(37)</samp></pre></li>
<li>Fire up the QSH <i>(all subsequent commands are run inside the qsh session.)</i>
<pre><samp>qsh</samp></pre>
</li>
<li>Set up the PATH: <pre><samp>export PATH=/QIBM/ProdData/DeveloperTools/qsh/bin:$PATH:/QOpenSys/usr/bin</samp></pre>
</li>
<li>Unpack the ICU source code archive:
<pre><samp>gzip -d icu-<i>X</i>.<i>Y</i>.tgz</samp></pre>
</li>
<li>Run unpax-icu.sh on the tar file generated from the previous step.
<pre><samp>unpax-icu.sh icu.tar</samp></pre></li>
<li>Build the program ICULD which ICU will use for linkage.
<pre><samp>cd icu/as_is/os400
qsh bldiculd.sh
cd ../../..</samp></pre>
</li>
<li>Change into the 'source' directory, and configure ICU. (See <a href="#HowToConfigureICU">configuration
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.
<pre><samp>cd icu/source
./runConfigureICU IBMi --prefix=<i>/path/to/somewhere</i> --with-data-packaging=archive</samp></pre>
</li>
<li>Build ICU. <i>(Note: Do not use the -j option)</i> <pre><samp>gmake</samp></pre></li>
<li>Test ICU. <pre><samp>gmake check</samp></pre>
(The <tt> QIBM_MULTI_THREADED=Y</tt> flag will be automatically applied to intltest -
you can look at the <a href=
"http://publib.boulder.ibm.com/infocenter/iseries/v5r3/index.jsp?topic=/apis/concept4.htm">
iSeries Information Center</a> for more details regarding the running of multiple threads
on IBM i.)</li>
</ol>
<!-- cross -->
<h3><a name="HowToCrossCompileICU" href="#HowToCrossCompileICU" id="HowToCrossCompileICU">How To Cross Compile ICU</a></h3>
<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>
<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>
<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>
<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>
<p>Three initially-empty directories will be used in this example:</p>
<table summary="Three directories used in this example" class="docTable">
<tr>
<th align="left">/icu</th><td>a copy of the ICU source</td>
</tr>
<tr>
<th align="left">/buildA</th><td>an empty directory, it will contain ICU built for A<br />(MacOSX in this case)</td>
</tr>
<tr>
<th align="left">/buildB</th><td>an empty directory, it will contain ICU built for B<br />(HaikuOS in this case)</td>
</tr>
</table>
<ol>
<li>Check out or unpack the ICU source code into the /icu directory.You will have the directories /icu/source, etc.</li>
<li>Build ICU in /buildA normally (using runConfigureICU or configure):
<pre class="samp">cd /buildA
sh /icu/source/runConfigureICU <strong>MacOSX</strong>
gnumake
</pre>
</li>
<li>Set PATH or other variables as needed, such as CPPFLAGS.</li>
<li>Build ICU in /buildB<br />
<div class="note"><b>Note:</b> "<code>--with-cross-build</code>" takes an absolute path.</div>
<pre class="samp">cd /buildB
sh /icu/source/configure --host=<strong>i586-pc-haiku</strong> --with-cross-build=<strong>/buildA</strong>
gnumake</pre>
</li>
<li>Tests and testdata can be built with "gnumake tests".</li>
</ol>
<!-- end cross -->
<!-- end build environment -->
<h2><a name="HowToPackage" href="#HowToPackage" id="HowToPackage">How To
Package ICU</a></h2>
<p>There are many ways that a person can package ICU with their software
products. Usually only the libraries need to be considered for packaging.</p>
<p>On UNIX, you should use "<tt>gmake install</tt>" to make it easier to
develop and package ICU. The bin, lib and include directories are needed to
develop applications that use ICU. These directories will be created relative
to the "<tt>--prefix=</tt><i>dir</i>" configure option (See the <a href=
"#HowToBuildUNIX">UNIX build instructions</a>). When ICU is built on Windows,
a similar directory structure is built.</p>
<p>When changes have been made to the standard ICU distribution, it is
recommended that at least one of the following guidelines be followed for
special packaging.</p>
<ol>
<li>Add a suffix name to the library names. This can be done with the
--with-library-suffix configure option.</li>
<li>The installation script should install the ICU libraries into the
application's directory.</li>
</ol>
<p>Following these guidelines prevents other applications that use a standard
ICU distribution from conflicting with any libraries that you need. On
operating systems that do not have a standard C++ ABI (name mangling) for
compilers, it is recommended to do this special packaging anyway. More
details on customizing ICU are available in the <a href=
"http://userguide.icu-project.org/">User's Guide</a>. The <a href=
"#SourceCode">ICU Source Code Organization</a> section of this readme.html
gives a more complete description of the libraries.</p>
<table class="docTable" summary=
"ICU has several libraries for you to use.">
<caption>
Here is an example of libraries that are frequently packaged.
</caption>
<tr>
<th scope="col">Library Name</th>
<th scope="col">Windows Filename</th>
<th scope="col">Linux Filename</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>Data Library</td>
<td>icudt<i>XY</i>l.dll</td>
<td>libicudata.so.<i>XY</i>.<i>Z</i></td>
<td>Data required by the Common and I18n libraries. There are many ways
to package and <a href=
"http://userguide.icu-project.org/icudata">customize this
data</a>, but by default this is all you need.</td>
</tr>
<tr>
<td>Common Library</td>
<td>icuuc<i>XY</i>.dll</td>
<td>libicuuc.so.<i>XY</i>.<i>Z</i></td>
<td>Base library required by all other ICU libraries.</td>
</tr>
<tr>
<td>Internationalization (i18n) Library</td>
<td>icuin<i>XY</i>.dll</td>
<td>libicui18n.so.<i>XY</i>.<i>Z</i></td>
<td>A library that contains many locale based internationalization (i18n)
functions.</td>
</tr>
<tr>
<td>Layout Engine</td>
<td>icule<i>XY</i>.dll</td>
<td>libicule.so.<i>XY</i>.<i>Z</i></td>
<td>An optional engine for doing font layout.</td>
</tr>
<tr>
<td>Layout Extensions Engine</td>
<td>iculx<i>XY</i>.dll</td>
<td>libiculx.so.<i>XY</i>.<i>Z</i></td>
<td>An optional engine for doing font layout that uses parts of ICU.</td>
</tr>
<tr>
<td>ICU I/O (Unicode stdio) Library</td>
<td>icuio<i>XY</i>.dll</td>
<td>libicuio.so.<i>XY</i>.<i>Z</i></td>
<td>An optional library that provides a stdio like API with Unicode
support.</td>
</tr>
<tr>
<td>Tool Utility Library</td>
<td>icutu<i>XY</i>.dll</td>
<td>libicutu.so.<i>XY</i>.<i>Z</i></td>
<td>An internal library that contains internal APIs that are only used by
ICU's tools. If you do not use ICU's tools, you do not need this
library.</td>
</tr>
</table>
<p>Normally only the above ICU libraries need to be considered for packaging.
The versionless symbolic links to these libraries are only needed for easier
development. The <i>X</i>, <i>Y</i> and <i>Z</i> parts of the name are the
version numbers of ICU. For example, ICU 2.0.2 would have the name
libicuuc.so.20.2 for the common library. The exact format of the library
names can vary between platforms due to how each platform can handles library
versioning.</p>
<h2><a name="ImportantNotes" href="#ImportantNotes" id=
"ImportantNotes">Important Notes About Using ICU</a></h2>
<h3><a name="ImportantNotesMultithreaded" href="#ImportantNotesMultithreaded"
id="ImportantNotesMultithreaded">Using ICU in a Multithreaded
Environment</a></h3>
<p>Some versions of ICU require calling the <code>u_init()</code> function
from <code>uclean.h</code> to ensure that ICU is initialized properly. In
those ICU versions, <code>u_init()</code> must be called before ICU is used
from multiple threads. There is no harm in calling <code>u_init()</code> in a
single-threaded application, on a single-CPU machine, or in other cases where
<code>u_init()</code> is not required.</p>
<p>In addition to ensuring thread safety, <code>u_init()</code> also attempts
to load at least one ICU data file. Assuming that all data files are packaged
together (or are in the same folder in files mode), a failure code from
<code>u_init()</code> usually means that the data cannot be found. In this
case, the data may not be installed properly, or the application may have
failed to call <code>udata_setCommonData()</code> or
<code>u_setDataDirectory()</code> which specify to ICU where it can find its
data.</p>
<p>Since <code>u_init()</code> will load only one or two data files, it
cannot guarantee that all of the data that an application needs is available.
It cannot check for all data files because the set of files is customizable,
and some ICU services work without loading any data at all. An application
should always check for error codes when opening ICU service objects (using
<code>ucnv_open()</code>, <code>ucol_open()</code>, C++ constructors,
etc.).</p>
<h4>ICU 3.4 and later</h4>
<p>ICU 3.4 self-initializes properly for multi-threaded use. It achieves this
without performance penalty by hardcoding the core Unicode properties data,
at the cost of some flexibility. (For details see Jitterbug 4497.)</p>
<p><code>u_init()</code> can be used to check for data loading. It tries to
load the converter alias table (<code>cnvalias.icu</code>).</p>
<h4>ICU 2.6..3.2</h4>
<p>These ICU versions require a call to <code>u_init()</code> before
multi-threaded use. The services that are directly affected are those that
don't have a service object and need to be fast: normalization and character
properties.</p>
<p><code>u_init()</code> loads and initializes the data files for
normalization and character properties (<code>unorm.icu</code> and
<code>uprops.icu</code>) and can therefore also be used to check for data
loading.</p>
<h4>ICU 2.4 and earlier</h4>
<p>ICU 2.4 and earlier versions were not prepared for multithreaded use on
multi-CPU platforms where the CPUs implement weak memory coherency. These
CPUs include: Power4, Power5, Alpha, Itanium. <code>u_init()</code> was not
defined yet.</p>
<h4><a name="ImportantNotesHPUX" href="#ImportantNotesHPUX" id=
"ImportantNotesHPUX">Using ICU in a Multithreaded Environment on
HP-UX</a></h4>
<p>When ICU is built with aCC on HP-UX, the <a
href="http://h21007.www2.hp.com/portal/site/dspp/menuitem.863c3e4cbcdc3f3515b49c108973a801?ciid=eb08b3f1eee02110b3f1eee02110275d6e10RCRD">-AA</a>
compiler flag is used. It is required in order to use the latest
<iostream> API in a thread safe manner. This compiler flag affects the
version of the C++ library being used. Your applications will also need to
be compiled with -AA in order to use ICU.</p>
<h4><a name="ImportantNotesSolaris" href="#ImportantNotesSolaris" id=
"ImportantNotesSolaris">Using ICU in a Multithreaded Environment on
Solaris</a></h4>
<h5>Linking on Solaris</h5>
<p>In order to avoid synchronization and threading issues, developers are
<strong>suggested</strong> to strictly follow the compiling and linking
guidelines for multithreaded applications, specified in the following
document from Sun Microsystems. Most notably, pay strict attention to the
following statements from Sun:</p>
<blockquote>
<p>To use libthread, specify -lthread before -lc on the ld command line, or
last on the cc command line.</p>
<p>To use libpthread, specify -lpthread before -lc on the ld command line,
or last on the cc command line.</p>
</blockquote>
<p>Failure to do this may cause spurious lock conflicts, recursive mutex
failure, and deadlock.</p>
<p>Source: "<i>Solaris Multithreaded Programming Guide, Compiling and
Debugging</i>", Sun Microsystems, Inc., Apr 2004<br />
<a href=
"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>
<h3><a name="ImportantNotesWindows" href="#ImportantNotesWindows" id=
"ImportantNotesWindows">Windows Platform</a></h3>
<p>If you are building on the Win32 platform, it is important that you
understand a few of the following build details.</p>
<h4>DLL directories and the PATH setting</h4>
<p>As delivered, the International Components for Unicode build as several
DLLs, which are placed in the "<i><ICU></i>\bin" directory. You must
add this directory to the PATH environment variable in your system, or any
executables you build will not be able to access International Components for
Unicode libraries. Alternatively, you can copy the DLL files into a directory
already in your PATH, but we do not recommend this. You can wind up with
multiple copies of the DLL and wind up using the wrong one.</p>
<h4><a name="ImportantNotesWindowsPath" id=
"ImportantNotesWindowsPath">Changing your PATH</a></h4>
<p><strong>Windows 2000/XP</strong>: Use the System Icon in the Control
Panel. Pick the "Advanced" tab. Select the "Environment Variables..."
button. Select the variable PATH in the lower box, and select the lower
"Edit..." button. In the "Variable Value" box, append the string
";<i><ICU></i>\bin" to the end of the path string. If there is
nothing there, just type in "<i><ICU></i>\bin". Click the Set button,
then the OK button.</p>
<p>Note: When packaging a Windows application for distribution and
installation on user systems, copies of the ICU DLLs should be included with
the application, and installed for exclusive use by the application. This is
the only way to insure that your application is running with the same version
of ICU, built with exactly the same options, that you developed and tested
with. Refer to Microsoft's guidelines on the usage of DLLs, or search for the
phrase "DLL hell" on <a href=
"http://msdn.microsoft.com/">msdn.microsoft.com</a>.</p>
<h3><a name="ImportantNotesUNIX" href="#ImportantNotesUNIX" id=
"ImportantNotesUNIX">UNIX Type Platform</a></h3>
<p>If you are building on a UNIX platform, and if you are installing ICU in a
non-standard location, you may need to add the location of your ICU libraries
to your <strong>LD_LIBRARY_PATH</strong> or <strong>LIBPATH</strong>
environment variable (or the equivalent runtime library path environment
variable for your system). The ICU libraries may not link or load properly
without doing this.</p>
<p>Note that if you do not want to have to set this variable, you may instead
use the --enable-rpath option at configuration time. This option will
instruct the linker to always look for the libraries where they are
installed. You will need to use the appropriate linker options when linking
your own applications and libraries against ICU, too. Please refer to your
system's linker manual for information about runtime paths. The use of rpath
also means that when building a new version of ICU you should not have an
older version installed in the same place as the new version's installation
directory, as the older libraries will used during the build, instead of the
new ones, likely leading to an incorrectly build ICU. This is the proper
behavior of rpath.</p>
<h2><a name="PlatformDependencies" href="#PlatformDependencies" id=
"PlatformDependencies">Platform Dependencies</a></h2>
<h3><a name="PlatformDependenciesNew" href="#PlatformDependenciesNew" id=
"PlatformDependenciesNew">Porting To A New Platform</a></h3>
<p>If you are using ICU's Makefiles to build ICU on a new platform, there are
a few places where you will need to add or modify some files. If you need
more help, you can always ask the <a href=
"http://site.icu-project.org/contacts">icu-support mailing list</a>. Once
you have finished porting ICU to a new platform, it is recommended that you
contribute your changes back to ICU via the icu-support mailing list. This
will make it easier for everyone to benefit from your work.</p>
<h4>Data For a New Platform</h4>
<p>For some people, it may not be necessary for completely build ICU. Most of
the makefiles and build targets are for tools that are used for building
ICU's data, and an application's data (when an application uses ICU resource
bundles for its data).</p>
<p>Data files can be built on a different platform when both platforms share
the same endianness and the same charset family. This assertion does not
include platform dependent DLLs/shared/static libraries. For details see the
User Guide <a href="http://userguide.icu-project.org/icudata">ICU
Data</a> chapter.</p>
<p>ICU 3.6 removes the requirement that ICU be completely built in the native
operating environment. It adds the icupkg tool which can be run on any
platform to turn binary ICU data files from any one of the three formats into
any one of the other data formats. This allows a application to use ICU data
built anywhere to be used for any other target platform.</p>
<p><strong>WARNING!</strong> Building ICU without running the tests is not
recommended. The tests verify that ICU is safe to use. It is recommended that
you try to completely port and test ICU before using the libraries for your
own application.</p>
<h4>Adapting Makefiles For a New Platform</h4>
<p>Try to follow the build steps from the <a href="#HowToBuildUNIX">UNIX</a>
build instructions. If the configure script fails, then you will need to
modify some files. Here are the usual steps for porting to a new
platform:<br />
</p>
<ol>
<li>Create an mh file in icu/source/config/. You can use mh-linux or a
similar mh file as your base configuration.</li>
<li>Modify icu/source/aclocal.m4 to recognize your platform's mh file.</li>
<li>Modify icu/source/configure.in to properly set your <b>platform</b> C
Macro define.</li>
<li>Run <a href="http://www.gnu.org/software/autoconf/">autoconf</a> in
icu/source/ without any options. The autoconf tool is standard on most
Linux systems.</li>
<li>If you have any optimization options that you want to normally use, you
can modify icu/source/runConfigureICU to specify those options for your
platform.</li>
<li>Build and test ICU on your platform. It is very important that you run
the tests. If you don't run the tests, there is no guarentee that you have
properly ported ICU.</li>
</ol>
<h3><a name="PlatformDependenciesImpl" href="#PlatformDependenciesImpl" id=
"PlatformDependenciesImpl">Platform Dependent Implementations</a></h3>
<p>The platform dependencies have been mostly isolated into the following
files in the common library. This information can be useful if you are
porting ICU to a new platform.</p>
<ul>
<li>
<strong>unicode/platform.h.in</strong> (autoconf'ed platforms)<br />
<strong>unicode/p<i>XXXX</i>.h</strong> (others: pwin32.h, ppalmos.h,
..): Platform-dependent typedefs and defines:<br />
<br />
<ul>
<li>Generic types like UBool, int8_t, int16_t, int32_t, int64_t,
uint64_t etc.</li>
<li>U_EXPORT and U_IMPORT for specifying dynamic library import and
export</li>
<li>String handling support for the char16_t and wchar_t types.</li>
</ul>
<br />
</li>
<li>
<strong>unicode/putil.h, putil.c</strong>: platform-dependent
implementations of various functions that are platform dependent:<br />
<br />
<ul>
<li>uprv_isNaN, uprv_isInfinite, uprv_getNaN and uprv_getInfinity for
handling special floating point values.</li>
<li>uprv_tzset, uprv_timezone, uprv_tzname and time for getting
platform specific time and time zone information.</li>
<li>u_getDataDirectory for getting the default data directory.</li>
<li>uprv_getDefaultLocaleID for getting the default locale
setting.</li>
<li>uprv_getDefaultCodepage for getting the default codepage
encoding.</li>
</ul>
<br />
</li>
<li>
<strong>umutex.h, umutex.c</strong>: Code for doing synchronization in
multithreaded applications. If you wish to use International Components
for Unicode in a multithreaded application, you must provide a
synchronization primitive that the classes can use to protect their
global data against simultaneous modifications. We already supply working
implementations for many platforms that ICU builds on.<br />
<br />
</li>
<li><strong>umapfile.h, umapfile.c</strong>: functions for mapping or
otherwise reading or loading files into memory. All access by ICU to data
from files makes use of these functions.<br />
<br />
</li>
<li>Using platform specific #ifdef macros are highly discouraged outside of
the scope of these files. When the source code gets updated in the future,
these #ifdef's can cause testing problems for your platform.</li>
</ul>
<hr />
<p>Copyright © 1997-2014 International Business Machines Corporation and
others. All Rights Reserved.<br />
IBM Globalization Center of Competency - San José<br />
4400 North First Street<br />
San José, CA 95134<br />
USA</p>
</body>
</html>