The libunibreak library
C Makefile Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src Remove word break properties obsolete in Unicode 11. Aug 4, 2018
tools Make a statement more precise. Dec 3, 2016
.clang-format `Modernize' the clang-format configuration to 3.8. Nov 26, 2016
.gitignore
.mailmap Update to make `git shortlog' correct again. Nov 11, 2013
AUTHORS Add changelog entry for Grapheme addition and add author. Nov 22, 2016
Doxyfile Fine-tune Doxygen configuration. Dec 14, 2016
LICENCE
Makefile.am Fix double running of tests. Dec 5, 2016
NEWS Update for the libunibreak 4.0 release. Dec 10, 2016
README.md
autogen.sh Add autogen.sh, which generates `configure' and runs it optionally. Feb 16, 2014
bootstrap Add a missing `--copy' argument to glibtoolize. Dec 10, 2016
configure.ac Update for the libunibreak 4.0 release. Dec 10, 2016
libunibreak.pc.in Rename the library to libunibreak, and prepare for release. Aug 11, 2012
purge Ignore `compile' and remove it on purge. Apr 19, 2015

README.md

LIBUNIBREAK

Overview

This is the README file for libunibreak, an implementation of the line breaking and word breaking algorithms as described in Unicode Standard Annex 14 and Unicode Standard Annex 29. Check the project's home page for up-to-date information.

Licence

This library is released under an open-source licence, the zlib/libpng licence. Please check the file LICENCE for details.

Apart from using the algorithm, part of the code is derived from the Unicode Public Data, and the Unicode Terms of Use may apply.

Installation

There are three ways to build the library:

  1. On *NIX systems supported by the autoconfiscation tools, do the normal

     ./configure
     make
     sudo make install
    

    to build and install both the dynamic and static libraries. In addition, one may

    • type make doc to generate the doxygen documentation; or
    • type make linebreakdata to regenerate linebreakdata.c from LineBreak.txt.
    • type make wordbreakdata to regenerate wordbreakdata.c from WordBreakProperty.txt.
    • type make graphemebreakdata to regenerate graphemebreakdata.c from GraphemeBreakProperty.txt.
  2. On systems where GCC and Binutils are supported, one can type

     cd src
     cp -p Makefile.gcc Makefile
     make
    

    to build the static library. In addition, one may

    • type make debug or make release to explicitly generate the debug or release build;
    • type make doc to generate the doxygen documentation; or
    • type make linebreakdata to regenerate linebreakdata.c from LineBreak.txt.
    • type make wordbreakdata to regenerate wordbreakdata.c from WordBreakProperty.txt.
    • type make graphemebreakdata to regenerate graphemebreakdata.c from GraphemeBreakProperty.txt.
  3. On Windows, apart from using method 1 (Cygwin/MSYS) and method 2 (MinGW), MSVC can also be used. Type

     cd src
     nmake -f Makefile.msvc
    

    to build the static library. By default the debug release is built. To build the release version

     nmake -f Makefile.msvc CFG="libunibreak - Win32 Release"
    

Documentation

Check the generated document doc/html/linebreak_8h.html, doc/html/wordbreak_8h.html, and doc/html/graphemebreak_8h.html in the downloaded file for the public interfaces exposed to applications.