README.md

Myanmar Tools C++ Documentation

This documentation is for C++ specific usage of Myanmar Tools. For general documentation, see the top-level README.

Building

From this directory:

$ cmake CMakeLists.txt
$ make
$ make test

The first line sets up your Makefiles and also downloads the dependencies: GLog, GTest, and ICU4C. The second line builds the code (on Unix-style environments), and the third line runs the tests.

Note: None of the dependencies need to be linked at runtime. GLog and GTest are only used for testing and debugging. ICU4C is used only for its header files; no library symbols are required.

Note: If the GTest build fails when running the above commands, try passing the following flag to cmake (see #42 for more discussion):

$ CXXFLAGS="-Wno-error=deprecated-copy" cmake CMakeLists.txt

Usage Examples

To detect Zawgyi, create a singleton instance of ZawgyiDetector, and call GetZawgyiProbability with your char* UTF-8 string.

static const auto* const detector = new google_myanmar_tools::ZawgyiDetector();
double score = detector->GetZawgyiProbability(u8"မ္း");
// score is now 0.999772 (very likely Zawgyi)

To convert Zawgyi to Unicode, create a singleton instance of ICU Transliterator with the transform ID "Zawgyi-my", and call Transliterate with your UnicodeString.

static const auto* const converter = // create transliterator instance (see below)
icu::UnicodeString output(u"မ္း");
converter->transliterate(output); // in-place conversion
// output is now u"မ်း"

To create a singleton ICU Transliterator instance, you can use the static initializer lambda function pattern in C++11:

static const auto* const converter = [] {
    icu::ErrorCode status;
    auto* converter = Transliterator::createInstance(
        "Zawgyi-my", UTRANS_FORWARD  , status);
    CHECK(status.isSuccess()) << ": " << status.errorName();
    return converter;
}();

For a complete working example, see samples/cpp/demo.cpp.