Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julp/FindICU.cmake
[CMake] [BSD-2] CMake module to find ICU
https://github.com/julp/FindICU.cmake
cmake icu
Last synced: about 2 months ago
JSON representation
[CMake] [BSD-2] CMake module to find ICU
- Host: GitHub
- URL: https://github.com/julp/FindICU.cmake
- Owner: julp
- License: bsd-2-clause
- Created: 2011-06-23T16:13:13.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2017-01-07T16:39:41.000Z (over 7 years ago)
- Last Synced: 2024-02-01T16:08:52.085Z (5 months ago)
- Topics: cmake, icu
- Language: C
- Homepage:
- Size: 102 KB
- Stars: 29
- Watchers: 6
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-cmake - FindICU.cmake - CMake module to find International Components for Unicode (ICU) Library. [```[BSD2]```][BSD-2-Clause] (Modules)
README
# FindICU.cmake
A CMake module to find International Components for Unicode (ICU) Library
[Note that CMake, since its version 3.7.0, includes a FindICU module](https://cmake.org/cmake/help/v3.7/module/FindICU.html#module:FindICU) that does **NOT** work in the same way at all (they are not compatible). Make sure, if you use the present module, to include it and give it the priority by redefining CMAKE_MODULE_PATH accordingly.
## Information
### Prerequisites
Only one:
* CMake >= 2.8.3 (for new version of find_package_handle_standard_args)
* CMake >= 2.8.5 to build static or shared resource bundles
### License
License: BSD-2 clause
## Usage
### Variables set for your project
* ICU_FOUND: were all of your specified components found?
* ICU_INCLUDE_DIRS: ICU include directory
* ICU_LIBRARIES: ICU libraries
* ICU_VERSION: complete version of ICU (x.y.z)
* ICU_VERSION_MAJOR: major version of ICU
* ICU_VERSION_MINOR: minor version of ICU
* ICU_VERSION_PATCH: patch version of ICU
* ICU_\_FOUND: was \ found? (FALSE for non specified component if it is not a dependency)
* ICU_C_FLAGS: C compiler flags
* ICU_CXX_FLAGS: C++ compiler flags
* ICU_CPP_FLAGS: C Preprocessor flags
* ICU_C_SHARED_FLAGS: C flags for building shared libraries
* ICU_CXX_SHARED_FLAGS: C++ flags for building shared libraries
* ICU_CPP_SHARED_FLAGS: C Preprocessor flags for building shared libraries
Note: all ICU_*_FLAGS variables will be defined as empty strings if icu-config does not exist or cannot be found
### Functions
#### Create resource bundles
```
icu_generate_resource_bundle(
NAME
FILES
[ FORMAT ]
[ PACKAGE ] [ TYPE ] [ DEPENDS ] [ NO_SHARED_FLAGS ]
[ DESTINATION ]
)
```
* NAME (string): mandatory, name of package (used to name dummy targets and output file)
* PACKAGE (boolean): mandatory to package the resource bundles into an archive or library (static as dynamic)
* FILES (;-list of strings): the text files to "compile" into resource bundles
* TYPE (string): implies *PACKAGE* to be present. Value is one among:
+ default: "common" (other name: "archive") to package the resource bundles as a .dat file
+ "static" to integrate all ressource bundles to targets designed by DEPENDS parameter (as a static library)
+ "library" (other name: "dll") to assemble all ressource bundles into a separate and loadable library (.dll/.so)
* DEPENDS (;-list of strings): only when *TYPE* is "library", "dll" or "static", a list of targets (add_executable for example) to link to
* FORMAT (string): default is ICU4C binary format, else one of "java" of "xliff"
* NO_SHARED_FLAGS (boolean): if set, skip appending *ICU_C(XX)_SHARED_FLAGS* to each target given as *DEPENDS* (only when *TYPE* is "static", "library" or "dll")
* DESTINATION (string): a directory where to install output files
See `tests/RB/c_*pkg*` for examples.
### How to use
#### For developpers
- You just need to copy the file FindICU.cmake at top of your project directory (you don't need sources for tests)
- Tell to CMake to search this non-standard module in your project directory by adding near top to your CMakeLists.txt: `set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR})`
- Just after, call find_package() once: `find_package(ICU)`
Notes:
* if ICU is required by your project, append the keyword *REQUIRED* (`find_package(ICU REQUIRED)`). On the opposite, if ICU is optional, the keyword *QUIET* can be used to silently try to find ICU.
* for a project which depends on a minimum version of ICU, add it just after 'ICU' (eg mandatory ICU >= 4.4: `find_package(ICU 4.4 REQUIRED)`)
* note that ICU is a set of several libraries and **by default, you only link to the ICU's base component called _uc_**. To link to any additionnal part of ICU, you have to list them behind the *COMPONENTS* keyword (eg: `find_package(ICU COMPONENTS io i18n)`). If not, you will issue linking (undefined symbol) errors. These components are:
+ the *uc* base (Unicode) component (string, case, normalisation, breakiterator) is always enabled (it can safely be omitted from *COMPONENTS*)
+ the *io* component is needed if you use ustdio (C) or ustream (C++). Note: *io* rely on *i18n*, its use imply to add *i18n* to *COMPONENTS*
+ the *i18n* component is required for charset conversions, formatting, collation, string search, transliteration, regexp, calendar/timezone
+ the *le*/*lx* for LayoutEngine/ParagraphLayout
#### For end users
If ICU is located in a non-regular place, add a `-DICU_ROOT_DIR=` option to your cmake command line.
### Sample
For a binary which implies ICU >= 4.4:
```cmake
set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR})
find_package(ICU 4.4 COMPONENTS io i18n REQUIRED)
include_directories(${ICU_INCLUDE_DIRS})
add_executable(tables tables.c)
target_link_libraries(tables ${ICU_LIBRARIES})
```
For CMake >= 3.0.0, you can also use an imported target. The same example becomes:
```cmake
set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR})
find_package(ICU 4.4 COMPONENTS io i18n REQUIRED)
add_executable(tables tables.c)
target_link_libraries(tables ICU::ICU)
```