You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Tony Kelman f7219d516e Fix make check 10 years ago
bench build bench/bench for make check, to lessen the chance that it bitrots again 10 years ago
data Prefix other C99 typedefs with utf8proc_ 10 years ago
test add toupper/tolower functions (for JuliaLang/julia#11471) 10 years ago
.gitignore add toupper/tolower functions (for JuliaLang/julia#11471) 10 years ago
.travis.yml fix #2: add charwidth function 10 years ago
CMakeLists.txt bump API/ABI version to 1.3, add NEWS 10 years ago
Doxyfile Fix #26: use doxygen for generating API docs 10 years ago
LICENSE.md updated NEWS etc. for 1.2 release 10 years ago
Makefile Fix make check 10 years ago
NEWS.md bump API/ABI version to 1.3, add NEWS 10 years ago
README.md fix link 10 years ago
appveyor.yml Run appveyor also on release branches 10 years ago
lump.md Minimal cmake build script 10 years ago
utf8proc.c add toupper/tolower functions (for JuliaLang/julia#11471) 10 years ago
utf8proc.h bump API/ABI version to 1.3, add NEWS 10 years ago
utf8proc_data.c Prefix other C99 typedefs with utf8proc_ 10 years ago
utils.cmake Minimal cmake build script 10 years ago

README.md

utf8proc

Build Status

utf8proc is a small, clean C library that provides Unicode normalization, case-folding, and other operations for data in the UTF-8 encoding. It was initially developed by Jan Behrens and the rest of the Public Software Group, who deserve nearly all of the credit for this package. With the blessing of the Public Software Group, the Julia developers have taken over development of utf8proc, since the original developers have moved to other projects.

(utf8proc is used for basic Unicode support in the Julia language, and the Julia developers became involved because they wanted to add Unicode 7 support and other features.)

(The original utf8proc package also includes Ruby and PostgreSQL plug-ins. We removed those from utf8proc in order to focus exclusively on the C library for the time being, but plan to add them back in or release them as separate packages.)

The utf8proc package is licensed under the free/open-source MIT "expat" license (plus certain Unicode data governed by the similarly permissive Unicode data license); please see the included LICENSE.md file for more detailed information.

Quick Start

For compilation of the C library run make.

General Information

The C library is found in this directory after successful compilation and is named libutf8proc.a (for the static library) and libutf8proc.so (for the dynamic library).

The Unicode version being supported is 7.0.0.

For Unicode normalizations, the following options are used:

  • Normalization Form C: STABLE, COMPOSE
  • Normalization Form D: STABLE, DECOMPOSE
  • Normalization Form KC: STABLE, COMPOSE, COMPAT
  • Normalization Form KD: STABLE, DECOMPOSE, COMPAT

C Library

The documentation for the C library is found in the utf8proc.h header file. utf8proc_map is function you will most likely be using for mapping UTF-8 strings, unless you want to allocate memory yourself.

To Do

See the Github issues list.

Contact

Bug reports, feature requests, and other queries can be filed at the utf8proc issues page on Github.