C library for processing UTF-8 and UTF-32 data
Go to file
2016-12-11 16:17:11 -05:00
bench use a different variable name for nested loop in bench.c (#80) 2016-07-26 17:54:17 -04:00
data Use versioned Unicode data URLs (#78) 2016-07-13 12:40:59 -04:00
test new utf8proc_map_custom for hooking in user-defined custom mappings (#89) 2016-11-30 10:40:26 -05:00
.gitignore update .gitignore for custom test 2016-11-30 10:46:01 -05:00
.travis.yml Move -Wmissing-prototypes from Makefile to .travis.yml (#79) 2016-07-16 11:16:03 +01:00
appveyor.yml Fix MinGW build test 2015-10-30 00:52:49 -04:00
CMakeLists.txt new utf8proc_map_custom for hooking in user-defined custom mappings (#89) 2016-11-30 10:40:26 -05:00
Doxyfile Fix #26: use doxygen for generating API docs 2015-03-21 21:23:02 -04:00
LICENSE.md updated NEWS etc. for 1.2 release 2015-03-28 09:10:00 -04:00
lump.md Minimal cmake build script 2015-03-08 17:30:09 -07:00
Makefile new utf8proc_map_custom for hooking in user-defined custom mappings (#89) 2016-11-30 10:40:26 -05:00
MANIFEST new utf8proc_map_custom for hooking in user-defined custom mappings (#89) 2016-11-30 10:40:26 -05:00
NEWS.md new utf8proc_map_custom for hooking in user-defined custom mappings (#89) 2016-11-30 10:40:26 -05:00
README.md add appveyor badge to readme 2016-07-13 09:18:40 -07:00
utf8proc_data.c silence MSVC warning about conversion to uint8 (fix #86) 2016-11-30 10:09:18 -05:00
utf8proc.c new utf8proc_map_custom for hooking in user-defined custom mappings (#89) 2016-11-30 10:40:26 -05:00
utf8proc.h use ptrdiff_t rather than ssize_t, as ssize_t is non-standard (it is POSIX, not C) 2016-12-11 16:17:11 -05:00
utils.cmake Minimal cmake build script 2015-03-08 17:30:09 -07:00

utf8proc

Travis CI Status AppVeyor 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 supported is 9.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.

See also

An independent Lua translation of this library, lua-mojibake, is also available.