FindICU¶
Added in version 3.7.
Finds the International Components for Unicode (ICU) libraries and programs.
Added in version 3.11: Support for static libraries on Windows.
Components¶
This module supports the following components:
dataFinds the ICU Data library. On Windows, this library component is named
dt, otherwise any of these component names may be used, and the appropriate platform-specific library name will be automatically selected.i18nFinds the ICU Internationalization library. On Windows, this library component is named
in, otherwise any of these component names may be used, and the appropriate platform-specific library name will be automatically selected.ioFinds the ICU Stream and I/O (Unicode stdio) library.
leFinds the deprecated ICU Layout Engine library, which has been removed as of ICU version 58.
lxFinds the ICU Layout Extensions Engine library, used for paragraph layout.
testFinds the ICU test suits.
tuFinds the ICU Tool Utility library.
ucFinds the base ICU Common and Data libraries. This library is required by all other ICU libraries and is recommended to include when working with ICU components.
At least one component should be specified for this module to successfully find ICU:
find_package(ICU COMPONENTS <components>...)
Imported Targets¶
This module provides the following Imported Targets:
ICU::<component>
Target encapsulating the usage requirements for the specified ICU component, available only if that component is found. The
<component>should be written in lowercase, as listed above. For example, useICU::i18nfor the Internationalization library.
Result Variables¶
This module defines the following variables:
ICU_FOUNDBoolean indicating whether the main programs and libraries were found.
ICU_INCLUDE_DIRSThe include directories containing the ICU headers.
ICU_LIBRARIESComponent libraries to be linked.
ICU_VERSIONThe version of the ICU release found.
ICU programs are defined in the following variables:
ICU_GENCNVAL_EXECUTABLEThe path to the
gencnvalexecutable.ICU_ICUINFO_EXECUTABLEThe path to the
icuinfoexecutable.ICU_GENBRK_EXECUTABLEThe path to the
genbrkexecutable.ICU_ICU-CONFIG_EXECUTABLEThe path to the
icu-configexecutable.ICU_GENRB_EXECUTABLEThe path to the
genrbexecutable.ICU_GENDICT_EXECUTABLEThe path to the
gendictexecutable.ICU_DERB_EXECUTABLEThe path to the
derbexecutable.ICU_PKGDATA_EXECUTABLEThe path to the
pkgdataexecutable.ICU_UCONV_EXECUTABLEThe path to the
uconvexecutable.ICU_GENCFU_EXECUTABLEThe path to the
gencfuexecutable.ICU_MAKECONV_EXECUTABLEThe path to the
makeconvexecutable.ICU_GENNORM2_EXECUTABLEThe path to the
gennorm2executable.ICU_GENCCODE_EXECUTABLEThe path to the
genccodeexecutable.ICU_GENSPREP_EXECUTABLEThe path to the
gensprepexecutable.ICU_ICUPKG_EXECUTABLEThe path to the
icupkgexecutable.ICU_GENCMN_EXECUTABLEThe path to the
gencmnexecutable.
ICU component libraries are defined in the following variables:
ICU_<COMPONENT>_FOUNDBoolean indicating whether the ICU component was found; The
<COMPONENT>should be written in uppercase.ICU_<COMPONENT>_LIBRARIESLibraries for component; The
<COMPONENT>should be written in uppercase.
ICU datafiles are defined in the following variables:
ICU_MAKEFILE_INCThe path to the
Makefile.incfile.ICU_PKGDATA_INCThe path to the
pkgdata.incfile.
Cache Variables¶
The following cache variables may also be set:
ICU_<PROGRAM>_EXECUTABLEThe path to executable
<PROGRAM>; The<PROGRAM>should be written in uppercase. These variables correspond to the ICU program result variables listed above.ICU_INCLUDE_DIRThe directory containing the ICU headers.
ICU_<COMPONENT>_LIBRARYThe library for the ICU component. The
<COMPONENT>should be written in uppercase.
Hints¶
This module reads hints about search results from:
ICU_ROOTThe root of the ICU installation. The environment variable
ICU_ROOTmay also be used; theICU_ROOTvariable takes precedence.
Note
In most cases, none of the above variables will need to be set, unless multiple versions of ICU are available and a specific version is required.
Examples¶
Finding ICU components and linking them to a project target:
find_package(ICU COMPONENTS i18n io uc)
target_link_libraries(project_target PRIVATE ICU::i18n ICU::io ICU::uc)