vouillon / uunf

Unicode text normalization for OCaml

Uunf — Unicode text normalization for OCaml

%%VERSION%% — Unicode version %%UNICODE_VERSION%%

Uunf is an OCaml library for normalizing Unicode text. It supports all Unicode normalization forms. The library is independent from any IO mechanism or Unicode text data structure and it can process text without a complete in-memory representation.

Uunf has no dependency. It may optionally depend on Uutf for support on OCaml UTF-X encoded strings. It is distributed under the ISC license.

Home page: http://erratique.ch/software/uunf
Contact: Daniel Bünzli <daniel.buenzl [e-mail]>

Installation

Uunf can be installed with opam:

opam install uunf
opam install uutf uunf # for support on OCaml UTF-X encoded strings

If you don't use opam consult the opam file for build instructions and a complete specification of the dependencies.

Documentation

The documentation and API reference is automatically generated by from the interfaces. It can be consulted online or via odig doc uunf.

Sample programs

If you installed Uuseg with opam sample programs are located in the directory opam config var uuseg:doc.

A few test programs are in the test directory of the distribution.

• test.native tests the library with the Unicode Normalization Test file available from:

  http://www.unicode.org/Public/%%UNICODEVERSION%%/ucd/NormalizationTest.txt

  Nothing should fail.

• test_string.native tests the UTF-X OCaml string support.

• unftrip.native inputs Unicode text on stdin and rewrites it on stdout in a given normalization form. Invoke with --help for more information. Depends on uutf and cmdliner.