// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*
* Copyright (C) 2012-2016, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
* file name: listformattertest.cpp
* encoding: UTF-8
* tab size: 8 (not used)
* indentation:4
*
* created on: 2012aug27
* created by: Umesh P. Nair
*/
#include "listformattertest.h"
#include "unicode/ulistformatter.h"
#include <string.h>
#if !UCONFIG_NO_FORMATTING
namespace {
const char* attrString(int32_t attrId) {
switch (attrId) {
case ULISTFMT_LITERAL_FIELD: return "literal";
case ULISTFMT_ELEMENT_FIELD: return "element";
default: return "xxx";
}
}
} // namespace
void ListFormatterTest::ExpectPositions(FieldPositionIterator& iter,
int32_t *values, int32_t tupleCount) {
UBool found[10];
FieldPosition fp;
if (tupleCount > 10) {
assertTrue("internal error, tupleCount too large", FALSE);
} else {
for (int i = 0; i < tupleCount; ++i) {
found[i] = FALSE;
}
}
while (iter.next(fp)) {
UBool ok = FALSE;
int32_t id = fp.getField();
int32_t start = fp.getBeginIndex();
int32_t limit = fp.getEndIndex();
char buf[128];
sprintf(buf, "%24s %3d %3d %3d", attrString(id), id, start, limit);
logln(buf);
for (int i = 0; i < tupleCount; ++i) {
if (found[i]) {
continue;
}
if (values[i*3] == id && values[i*3+1] == start && values[i*3+2] == limit) {
found[i] = ok = TRUE;
break;
}
}
assertTrue((UnicodeString)"found [" + attrString(id) + "," + start + "," + limit + "]", ok);
}
// check that all were found
UBool ok = TRUE;
for (int i = 0; i < tupleCount; ++i) {
if (!found[i]) {
ok = FALSE;
assertTrue((UnicodeString) "missing [" + attrString(values[i*3]) + "," + values[i*3+1] +
"," + values[i*3+2] + "]", found[i]);
}
}
assertTrue("no expected values were missing", ok);
}
ListFormatterTest::ListFormatterTest() :
prefix("Prefix: ", -1, US_INV),
one("Alice", -1, US_INV), two("Bob", -1, US_INV),
three("Charlie", -1, US_INV), four("Delta", -1, US_INV) {
}
void ListFormatterTest::CheckFormatting(const ListFormatter* formatter, UnicodeString data[], int32_t dataSize,
const UnicodeString& expected_result, const char* testName) {
UnicodeString actualResult(prefix);
IcuTestErrorCode errorCode(*this, testName);
formatter->format(data, dataSize, actualResult, errorCode);
UnicodeString expectedStringWithPrefix = prefix + expected_result;
if (expectedStringWithPrefix != actualResult) {
errln(UnicodeString("Expected: |") + expectedStringWithPrefix + "|, Actual: |" + actualResult + "|");
}
}
void ListFormatterTest::CheckFourCases(const char* locale_string, UnicodeString one, UnicodeString two,
UnicodeString three, UnicodeString four, UnicodeString results[4], const char* testName) {
IcuTestErrorCode errorCode(*this, testName);
LocalPointer<ListFormatter> formatter(ListFormatter::createInstance(Locale(locale_string), errorCode));
if (U_FAILURE(errorCode)) {
dataerrln("ListFormatter::createInstance(Locale(\"%s\"), errorCode) failed in CheckFourCases: %s", locale_string, u_errorName(errorCode));
return;
}
UnicodeString input1[] = {one};
CheckFormatting(formatter.getAlias(), input1, 1, results[0], testName);
UnicodeString input2[] = {one, two};
CheckFormatting(formatter.getAlias(), input2, 2, results[1], testName);
UnicodeString input3[] = {one, two, three};
CheckFormatting(formatter.getAlias(), input3, 3, results[2], testName);
UnicodeString input4[] = {one, two, three, four};
CheckFormatting(formatter.getAlias(), input4, 4, results[3], testName);
}
UBool ListFormatterTest::RecordFourCases(const Locale& locale, UnicodeString one, UnicodeString two,
UnicodeString three, UnicodeString four, UnicodeString results[4], const char* testName) {
IcuTestErrorCode errorCode(*this, testName);
LocalPointer<ListFormatter> formatter(ListFormatter::createInstance(locale, errorCode));
if (U_FAILURE(errorCode)) {
dataerrln("ListFormatter::createInstance(\"%s\", errorCode) failed in RecordFourCases: %s", locale.getName(), u_errorName(errorCode));
return FALSE;
}
UnicodeString input1[] = {one};
formatter->format(input1, 1, results[0], errorCode);
UnicodeString input2[] = {one, two};
formatter->format(input2, 2, results[1], errorCode);
UnicodeString input3[] = {one, two, three};
formatter->format(input3, 3, results[2], errorCode);
UnicodeString input4[] = {one, two, three, four};
formatter->format(input4, 4, results[3], errorCode);
if (U_FAILURE(errorCode)) {
errln("RecordFourCases failed: %s", u_errorName(errorCode));
return FALSE;
}
return TRUE;
}
void ListFormatterTest::TestRoot() {
UnicodeString results[4] = {
one,
one + ", " + two,
one + ", " + two + ", " + three,
one + ", " + two + ", " + three + ", " + four
};
CheckFourCases("", one, two, three, four, results, "TestRoot()");
}
// Bogus locale should fallback to root.
void ListFormatterTest::TestBogus() {
UnicodeString results[4];
if (RecordFourCases(Locale::getDefault(), one, two, three, four, results, "TestBogus()")) {
CheckFourCases("ex_PY", one, two, three, four, results, "TestBogus()");
}
}
// Formatting in English.
// "and" is used before the last element, and all elements up to (and including) the penultimate are followed by a comma.
void ListFormatterTest::TestEnglish() {
UnicodeString results[4] = {
one,
one + " and " + two,
one + ", " + two + ", and " + three,
one + ", " + two + ", " + three + ", and " + four
};
CheckFourCases("en", one, two, three, four, results, "TestEnglish()");
}
void ListFormatterTest::Test9946() {
IcuTestErrorCode errorCode(*this, "Test9946()");
LocalPointer<ListFormatter> formatter(ListFormatter::createInstance(Locale("en"), errorCode));
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::createInstance(Locale(\"en\"), errorCode) failed in Test9946: %s",
u_errorName(errorCode));
return;
}
UnicodeString data[3] = {"{0}", "{1}", "{2}"};
UnicodeString actualResult;
formatter->format(data, 3, actualResult, errorCode);
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::createInstance(Locale(\"en\"), errorCode) failed in Test9946: %s",
u_errorName(errorCode));
return;
}
UnicodeString expected("{0}, {1}, and {2}");
if (expected != actualResult) {
errln("Expected " + expected + ", got " + actualResult);
}
}
void ListFormatterTest::TestEnglishUS() {
UnicodeString results[4] = {
one,
one + " and " + two,
one + ", " + two + ", and " + three,
one + ", " + two + ", " + three + ", and " + four
};
CheckFourCases("en_US", one, two, three, four, results, "TestEnglishUS()");
}
// Tests resource loading and inheritance when region sublocale
// has only partial data for the listPattern element (overriding
// some of the parent data). #12994
void ListFormatterTest::TestEnglishGB() {
UnicodeString results[4] = {
one,
one + " and " + two,
one + ", " + two + " and " + three,
one + ", " + two + ", " + three + " and " + four
};
CheckFourCases("en_GB", one, two, three, four, results, "TestEnglishGB()");
}
void ListFormatterTest::TestFieldPositionIteratorWontCrash() {
IcuTestErrorCode errorCode(*this, "TestFieldPositionIteratorWontCrash()");
LocalPointer<ListFormatter> formatter(
ListFormatter::createInstance(Locale("en"), errorCode));
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::createInstance(Locale(\"en\"), errorCode) failed in "
"TestFieldPositionIteratorWontCrash: %s",
u_errorName(errorCode));
return;
}
UnicodeString data[3] = {"a", "bbb", "cc"};
UnicodeString actualResult;
// make sure NULL as FieldPositionIterator won't caused crash.
formatter->format(data, 3, actualResult, nullptr, errorCode);
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::format(data, 3, nullptr, errorCode) "
"failed in TestFieldPositionIteratorWontCrash: %s",
u_errorName(errorCode));
return;
}
}
void ListFormatterTest::RunTestFieldPositionIteratorWithFormatter(
ListFormatter* formatter,
UnicodeString data[], int32_t n, int32_t expected[], int32_t tupleCount,
UnicodeString& appendTo, const char16_t *expectedFormatted,
const char* testName) {
IcuTestErrorCode errorCode(*this, testName);
FieldPositionIterator iter;
formatter->format(data, n, appendTo, &iter, errorCode);
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::format(data, %d, &iter, errorCode) "
"failed in %s: %s", n, testName, u_errorName(errorCode));
return;
}
if (appendTo != expectedFormatted) {
errln(UnicodeString("Expected: |") + expectedFormatted + "|, Actual: |" + appendTo + "|");
}
ExpectPositions(iter, expected, tupleCount);
}
void ListFormatterTest::RunTestFieldPositionIteratorWithNItemsPatternShift(
UnicodeString data[], int32_t n, int32_t expected[], int32_t tupleCount,
UnicodeString& appendTo, const char16_t *expectedFormatted,
const char* testName) {
IcuTestErrorCode errorCode(*this, testName);
LocalPointer<ListFormatter> formatter(
ListFormatter::createInstance(Locale("ur", "IN"), "unit-narrow", errorCode));
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::createInstance(Locale(\"ur\", \"IN\"), \"unit-narrow\", errorCode) failed in "
"%s: %s", testName, u_errorName(errorCode));
return;
}
RunTestFieldPositionIteratorWithFormatter(
formatter.getAlias(),
data, n, expected, tupleCount, appendTo, expectedFormatted, testName);
}
void ListFormatterTest::RunTestFieldPositionIteratorWithNItems(
UnicodeString data[], int32_t n, int32_t expected[], int32_t tupleCount,
UnicodeString& appendTo, const char16_t *expectedFormatted,
const char* testName) {
IcuTestErrorCode errorCode(*this, testName);
LocalPointer<ListFormatter> formatter(
ListFormatter::createInstance(Locale("en"), errorCode));
if (U_FAILURE(errorCode)) {
dataerrln(
"ListFormatter::createInstance(Locale(\"en\"), errorCode) failed in "
"%s: %s", testName, u_errorName(errorCode));
return;
}
RunTestFieldPositionIteratorWithFormatter(
formatter.getAlias(),
data, n, expected, tupleCount, appendTo, expectedFormatted, testName);
}
void ListFormatterTest::TestFieldPositionIteratorWith3ItemsAndDataBefore() {
// 0 1 2
// 0123456789012345678901234567
// "Hello World: a, bbb, and cc"
UnicodeString data[3] = {"a", "bbb", "cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 13, 14,
ULISTFMT_LITERAL_FIELD, 14, 16,
ULISTFMT_ELEMENT_FIELD, 16, 19,
ULISTFMT_LITERAL_FIELD, 19, 25,
ULISTFMT_ELEMENT_FIELD, 25, 27
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo(u"Hello World: ");
RunTestFieldPositionIteratorWithNItems(
data, 3, expected, tupleCount, appendTo,
u"Hello World: a, bbb, and cc",
"TestFieldPositionIteratorWith3ItemsAndDataBefore");
}
void ListFormatterTest::TestFieldPositionIteratorWith3Items() {
// 0 1
// 012345678901234
// "a, bbb, and cc"
UnicodeString data[3] = {"a", "bbb", "cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 0, 1,
ULISTFMT_LITERAL_FIELD, 1, 3,
ULISTFMT_ELEMENT_FIELD, 3, 6,
ULISTFMT_LITERAL_FIELD, 6, 12,
ULISTFMT_ELEMENT_FIELD, 12, 14
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo;
RunTestFieldPositionIteratorWithNItems(
data, 3, expected, tupleCount, appendTo,
u"a, bbb, and cc",
"TestFieldPositionIteratorWith3Items");
}
void ListFormatterTest::TestFieldPositionIteratorWith3ItemsPatternShift() {
// 0 1
// 012345678901234
// "cc bbb a"
UnicodeString data[3] = {"a", "bbb", "cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 7, 8,
ULISTFMT_LITERAL_FIELD, 6, 7,
ULISTFMT_ELEMENT_FIELD, 3, 6,
ULISTFMT_LITERAL_FIELD, 2, 3,
ULISTFMT_ELEMENT_FIELD, 0, 2
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo;
RunTestFieldPositionIteratorWithNItemsPatternShift(
data, 3, expected, tupleCount, appendTo,
u"cc bbb a",
"TestFieldPositionIteratorWith3ItemsPatternShift");
}
void ListFormatterTest::TestFieldPositionIteratorWith2ItemsAndDataBefore() {
// 0 1
// 0123456789012345
// "Foo: bbb and cc"
UnicodeString data[2] = {"bbb", "cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 5, 8,
ULISTFMT_LITERAL_FIELD, 8, 13,
ULISTFMT_ELEMENT_FIELD, 13, 15
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo("Foo: ");
RunTestFieldPositionIteratorWithNItems(
data, 2, expected, tupleCount, appendTo,
u"Foo: bbb and cc",
"TestFieldPositionIteratorWith2ItemsAndDataBefore");
}
void ListFormatterTest::TestFieldPositionIteratorWith2Items() {
// 0 1
// 01234567890
// "bbb and cc"
UnicodeString data[2] = {"bbb", "cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 0, 3,
ULISTFMT_LITERAL_FIELD, 3, 8,
ULISTFMT_ELEMENT_FIELD, 8, 10
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo;
RunTestFieldPositionIteratorWithNItems(
data, 2, expected, tupleCount, appendTo,
u"bbb and cc",
"TestFieldPositionIteratorWith2Items");
}
void ListFormatterTest::TestFieldPositionIteratorWith2ItemsPatternShift() {
// 0 1
// 01234567890
// "cc bbb"
UnicodeString data[2] = {"bbb", "cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 3, 6,
ULISTFMT_LITERAL_FIELD, 2, 3,
ULISTFMT_ELEMENT_FIELD, 0, 2
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo;
RunTestFieldPositionIteratorWithNItemsPatternShift(
data, 2, expected, tupleCount, appendTo,
u"cc bbb",
"TestFieldPositionIteratorWith2ItemsPatternShift");
}
void ListFormatterTest::TestFieldPositionIteratorWith1ItemAndDataBefore() {
// 012345678
// "Hello cc"
UnicodeString data[1] = {"cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 6, 8
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo("Hello ");
RunTestFieldPositionIteratorWithNItems(
data, 1, expected, tupleCount, appendTo,
u"Hello cc",
"TestFieldPositionIteratorWith1ItemAndDataBefore");
}
void ListFormatterTest::TestFieldPositionIteratorWith1Item() {
// 012
// "cc"
UnicodeString data[1] = {"cc"};
int32_t expected[] = {
ULISTFMT_ELEMENT_FIELD, 0, 2
};
int32_t tupleCount = sizeof(expected)/(3 * sizeof(*expected));
UnicodeString appendTo;
RunTestFieldPositionIteratorWithNItems(
data, 1, expected, tupleCount, appendTo,
u"cc",
"TestFieldPositionIteratorWith1Item");
}
// Tests resource loading and inheritance when region sublocale
// has only partial data for the listPattern element (overriding
// some of the parent data). #12994
void ListFormatterTest::TestNynorsk() {
UnicodeString results[4] = {
one,
one + " og " + two,
one + ", " + two + " og " + three,
one + ", " + two + ", " + three + " og " + four
};
CheckFourCases("nn", one, two, three, four, results, "TestNynorsk()");
}
// Tests resource loading and inheritance when region sublocale
// has only partial data for the listPattern element (overriding
// some of the parent data). #12994
void ListFormatterTest::TestChineseTradHK() {
UnicodeString and_string = UnicodeString("\\u53CA", -1, US_INV).unescape();
UnicodeString comma_string = UnicodeString("\\u3001", -1, US_INV).unescape();
UnicodeString results[4] = {
one,
one + and_string + two,
one + comma_string + two + and_string + three,
one + comma_string + two + comma_string + three + and_string + four
};
CheckFourCases("zh_Hant_HK", one, two, three, four, results, "TestChineseTradHK()");
}
// Formatting in Russian.
// "\\u0438" is used before the last element, and all elements up to (but not including) the penultimate are followed by a comma.
void ListFormatterTest::TestRussian() {
UnicodeString and_string = UnicodeString(" \\u0438 ", -1, US_INV).unescape();
UnicodeString results[4] = {
one,
one + and_string + two,
one + ", " + two + and_string + three,
one + ", " + two + ", " + three + and_string + four
};
CheckFourCases("ru", one, two, three, four, results, "TestRussian()");
}
// Formatting in Malayalam.
// For two elements, "\\u0d15\\u0d42\\u0d1f\\u0d3e\\u0d24\\u0d46" is inserted in between.
// For more than two elements, comma is inserted between all elements up to (and including) the penultimate,
// and the word \\u0d0e\\u0d28\\u0d4d\\u0d28\\u0d3f\\u0d35 is inserted in the end.
void ListFormatterTest::TestMalayalam() {
UnicodeString pair_string = UnicodeString(" \\u0d15\\u0d42\\u0d1f\\u0d3e\\u0d24\\u0d46 ", -1, US_INV).unescape();
UnicodeString total_string = UnicodeString(" \\u0d0e\\u0d28\\u0d4d\\u0d28\\u0d3f\\u0d35", -1, US_INV).unescape();
UnicodeString results[4] = {
one,
one + pair_string + two,
one + ", " + two + ", " + three + total_string,
one + ", " + two + ", " + three + ", " + four + total_string
};
CheckFourCases("ml", one, two, three, four, results, "TestMalayalam()");
}
// Formatting in Zulu.
// "and" is used before the last element, and all elements up to (and including) the penultimate are followed by a comma.
void ListFormatterTest::TestZulu() {
UnicodeString results[4] = {
one,
one + " ne-" + two,
one + ", " + two + ", ne-" + three,
one + ", " + two + ", " + three + ", ne-" + four
};
CheckFourCases("zu", one, two, three, four, results, "TestZulu()");
}
void ListFormatterTest::TestOutOfOrderPatterns() {
UnicodeString results[4] = {
one,
two + " after " + one,
three + " in the last after " + two + " after the first " + one,
four + " in the last after " + three + " after " + two + " after the first " + one
};
IcuTestErrorCode errorCode(*this, "TestOutOfOrderPatterns()");
ListFormatData data("{1} after {0}", "{1} after the first {0}",
"{1} after {0}", "{1} in the last after {0}");
ListFormatter formatter(data, errorCode);
UnicodeString input1[] = {one};
CheckFormatting(&formatter, input1, 1, results[0], "TestOutOfOrderPatterns()");
UnicodeString input2[] = {one, two};
CheckFormatting(&formatter, input2, 2, results[1], "TestOutOfOrderPatterns()");
UnicodeString input3[] = {one, two, three};
CheckFormatting(&formatter, input3, 3, results[2], "TestOutOfOrderPatterns()");
UnicodeString input4[] = {one, two, three, four};
CheckFormatting(&formatter, input4, 4, results[3], "TestOutOfOrderPatterns()");
}
void ListFormatterTest::runIndexedTest(int32_t index, UBool exec,
const char* &name, char* /*par */) {
switch(index) {
case 0: name = "TestRoot"; if (exec) TestRoot(); break;
case 1: name = "TestBogus"; if (exec) TestBogus(); break;
case 2: name = "TestEnglish"; if (exec) TestEnglish(); break;
case 3: name = "TestEnglishUS"; if (exec) TestEnglishUS(); break;
case 4: name = "TestRussian"; if (exec) TestRussian(); break;
case 5: name = "TestMalayalam"; if (exec) TestMalayalam(); break;
case 6: name = "TestZulu"; if (exec) TestZulu(); break;
case 7: name = "TestOutOfOrderPatterns"; if (exec) TestOutOfOrderPatterns(); break;
case 8: name = "Test9946"; if (exec) Test9946(); break;
case 9: name = "TestEnglishGB"; if (exec) TestEnglishGB(); break;
case 10: name = "TestNynorsk"; if (exec) TestNynorsk(); break;
case 11: name = "TestChineseTradHK"; if (exec) TestChineseTradHK(); break;
case 12: name = "TestFieldPositionIteratorWontCrash";
if (exec) TestFieldPositionIteratorWontCrash();
break;
case 13: name = "TestFieldPositionIteratorWith1Item";
if (exec) TestFieldPositionIteratorWith1Item();
break;
case 14: name = "TestFieldPositionIteratorWith1ItemAndDataBefore";
if (exec) TestFieldPositionIteratorWith1ItemAndDataBefore();
break;
case 15: name = "TestFieldPositionIteratorWith2Items";
if (exec) TestFieldPositionIteratorWith2Items();
break;
case 16: name = "TestFieldPositionIteratorWith2ItemsAndDataBefore";
if (exec) TestFieldPositionIteratorWith2ItemsAndDataBefore();
break;
case 17: name = "TestFieldPositionIteratorWith2ItemsPatternShift";
if (exec) TestFieldPositionIteratorWith2ItemsPatternShift();
break;
case 18: name = "TestFieldPositionIteratorWith3Items";
if (exec) TestFieldPositionIteratorWith3Items();
break;
case 19: name = "TestFieldPositionIteratorWith3ItemsAndDataBefore";
if (exec) TestFieldPositionIteratorWith3ItemsAndDataBefore();
break;
case 20: name = "TestFieldPositionIteratorWith3ItemsPatternShift";
if (exec) TestFieldPositionIteratorWith3ItemsPatternShift();
break;
default: name = ""; break;
}
}
#endif /* #if !UCONFIG_NO_FORMATTING */