[string] new functions for case-insensitive comparison (#7189)

This commit adds new string helper functions to convert between
lowercase and uppercase letters. It also adds new function
`StringStartsWith()` which determines whether the string starts with
a given prefix string and `StringMatch()` which compares and matches
two strings.

This commit also adds a new mechanism in all string helper functions
allowing the caller to specify the match mode to be used when
comparing strings: Either an exact match of characters, or a
case-insensitive match where uppercase and lowercase characters are
treated as equal.

This commit also updates `test_string` unit test to validate the new
functions and behaviors.
This commit is contained in:
Abtin Keshavarzian
2021-11-23 16:31:18 -08:00
committed by Jonathan Hui
parent d82a678322
commit 07031e1651
3 changed files with 324 additions and 30 deletions
+121 -15
View File
@@ -49,7 +49,7 @@ template <uint16_t kSize> void PrintString(const char *aName, const String<kSize
void TestStringWriter(void)
{
String<kStringSize> str;
constexpr char kLongString[] = "abcdefghijklmnopqratuvwxyzabcdefghijklmnopqratuvwxyz";
const char kLongString[] = "abcdefghijklmnopqratuvwxyzabcdefghijklmnopqratuvwxyz";
printf("\nTest 1: StringWriter constructor\n");
@@ -147,12 +147,12 @@ void TestUtf8(void)
void TestStringFind(void)
{
char emptyString[1] = {'\0'};
char testString[] = "foo.bar.bar\\.";
char testString[] = "Foo.bar.bar\\.";
char testString2[] = "abcabcabcdabc";
printf("\nTest 6: StringFind() function\n");
VerifyOrQuit(StringFind(testString, 'f') == testString);
VerifyOrQuit(StringFind(testString, 'F') == testString);
VerifyOrQuit(StringFind(testString, 'o') == &testString[1]);
VerifyOrQuit(StringFind(testString, '.') == &testString[3]);
VerifyOrQuit(StringFind(testString, 'r') == &testString[6]);
@@ -160,17 +160,19 @@ void TestStringFind(void)
VerifyOrQuit(StringFind(testString, 'x') == nullptr);
VerifyOrQuit(StringFind(testString, ',') == nullptr);
VerifyOrQuit(StringFind(emptyString, 'f') == nullptr);
VerifyOrQuit(StringFind(emptyString, 'F') == nullptr);
VerifyOrQuit(StringFind(emptyString, '.') == nullptr);
VerifyOrQuit(StringFind(testString, "foo") == &testString[0]);
VerifyOrQuit(StringFind(testString, "Foo") == &testString[0]);
VerifyOrQuit(StringFind(testString, "oo") == &testString[1]);
VerifyOrQuit(StringFind(testString, "bar") == &testString[4]);
VerifyOrQuit(StringFind(testString, "bar\\") == &testString[8]);
VerifyOrQuit(StringFind(testString, "\\.") == &testString[11]);
VerifyOrQuit(StringFind(testString, testString) == testString);
VerifyOrQuit(StringFind(testString, "fooo") == nullptr);
VerifyOrQuit(StringFind(testString, "far") == nullptr);
VerifyOrQuit(StringFind(testString, "Fooo") == nullptr);
VerifyOrQuit(StringFind(testString, "Far") == nullptr);
VerifyOrQuit(StringFind(testString, "FOO") == nullptr);
VerifyOrQuit(StringFind(testString, "BAR") == nullptr);
VerifyOrQuit(StringFind(testString, "bar\\..") == nullptr);
VerifyOrQuit(StringFind(testString, "") == &testString[0]);
@@ -182,27 +184,128 @@ void TestStringFind(void)
VerifyOrQuit(StringFind(testString2, "abcabc") == &testString2[0]);
VerifyOrQuit(StringFind(testString2, "abcabcd") == &testString2[3]);
VerifyOrQuit(StringFind(testString, "FOO", kStringCaseInsensitiveMatch) == &testString[0]);
VerifyOrQuit(StringFind(testString, "OO", kStringCaseInsensitiveMatch) == &testString[1]);
VerifyOrQuit(StringFind(testString, "BAR", kStringCaseInsensitiveMatch) == &testString[4]);
VerifyOrQuit(StringFind(testString, "BAR\\", kStringCaseInsensitiveMatch) == &testString[8]);
VerifyOrQuit(StringFind(testString, "\\.", kStringCaseInsensitiveMatch) == &testString[11]);
VerifyOrQuit(StringFind(testString, testString) == testString);
VerifyOrQuit(StringFind(testString, "FOOO", kStringCaseInsensitiveMatch) == nullptr);
VerifyOrQuit(StringFind(testString, "FAR", kStringCaseInsensitiveMatch) == nullptr);
VerifyOrQuit(StringFind(testString, "BAR\\..", kStringCaseInsensitiveMatch) == nullptr);
VerifyOrQuit(StringFind(testString, "", kStringCaseInsensitiveMatch) == &testString[0]);
VerifyOrQuit(StringFind(emptyString, "FOO", kStringCaseInsensitiveMatch) == nullptr);
VerifyOrQuit(StringFind(emptyString, "BAR", kStringCaseInsensitiveMatch) == nullptr);
VerifyOrQuit(StringFind(emptyString, "", kStringCaseInsensitiveMatch) == &emptyString[0]);
// Verify when sub-string has repeated patterns
VerifyOrQuit(StringFind(testString2, "ABCABC", kStringCaseInsensitiveMatch) == &testString2[0]);
VerifyOrQuit(StringFind(testString2, "ABCABCD", kStringCaseInsensitiveMatch) == &testString2[3]);
printf(" -- PASS\n");
}
void TestStringStartsWith(void)
{
printf("\nTest 7: StringStartsWith() function\n");
VerifyOrQuit(StringStartsWith("FooBar", "Foo"));
VerifyOrQuit(!StringStartsWith("FooBar", "Ba"));
VerifyOrQuit(StringStartsWith("FooBar", "FooBar"));
VerifyOrQuit(!StringStartsWith("FooBar", "FooBarr"));
VerifyOrQuit(!StringStartsWith("FooBar", "foo"));
VerifyOrQuit(!StringStartsWith("FooBar", "FoO"));
VerifyOrQuit(!StringStartsWith("", "foo"));
VerifyOrQuit(StringStartsWith("FooBar", "FOO", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringStartsWith("FooBar", "BA", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringStartsWith("FooBar", "FOOBAR", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringStartsWith("FooBar", "FooBarr", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringStartsWith("FooBar", "foO", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringStartsWith("", "foo", kStringCaseInsensitiveMatch));
printf(" -- PASS\n");
}
void TestStringEndsWith(void)
{
printf("\nTest 7: StringEndsWith() function\n");
printf("\nTest 8: StringEndsWith() function\n");
VerifyOrQuit(StringEndsWith("foobar", 'r'));
VerifyOrQuit(!StringEndsWith("foobar", 'a'));
VerifyOrQuit(!StringEndsWith("foobar", '\0'));
VerifyOrQuit(StringEndsWith("FooBar", 'r'));
VerifyOrQuit(!StringEndsWith("FooBar", 'a'));
VerifyOrQuit(!StringEndsWith("FooBar", '\0'));
VerifyOrQuit(StringEndsWith("a", 'a'));
VerifyOrQuit(!StringEndsWith("a", 'b'));
VerifyOrQuit(StringEndsWith("foobar", "bar"));
VerifyOrQuit(!StringEndsWith("foobar", "ba"));
VerifyOrQuit(StringEndsWith("foobar", "foobar"));
VerifyOrQuit(!StringEndsWith("foobar", "foobarr"));
VerifyOrQuit(StringEndsWith("FooBar", "Bar"));
VerifyOrQuit(!StringEndsWith("FooBar", "Ba"));
VerifyOrQuit(StringEndsWith("FooBar", "FooBar"));
VerifyOrQuit(!StringEndsWith("FooBar", "FooBarr"));
VerifyOrQuit(!StringEndsWith("", 'a'));
VerifyOrQuit(!StringEndsWith("", "foo"));
VerifyOrQuit(StringEndsWith("FooBar", "baR", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringEndsWith("FooBar", "bA", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringEndsWith("FooBar", "fOOBar", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringEndsWith("FooBar", "Foobarr", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringEndsWith("", "Foo", kStringCaseInsensitiveMatch));
printf(" -- PASS\n");
}
void TestStringMatch(void)
{
printf("\nTest 9: StringMatch() function\n");
VerifyOrQuit(StringMatch("", ""));
VerifyOrQuit(StringMatch("FooBar", "FooBar"));
VerifyOrQuit(!StringMatch("FooBar", "FooBa"));
VerifyOrQuit(!StringMatch("FooBa", "FooBar"));
VerifyOrQuit(!StringMatch("FooBa", "FooBar"));
VerifyOrQuit(!StringMatch("FooBar", "fooBar"));
VerifyOrQuit(!StringMatch("FooBaR", "FooBar"));
VerifyOrQuit(StringMatch("", "", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringMatch("FooBar", "fOObAR", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringMatch("FooBar", "fOObA", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringMatch("FooBa", "FooBar", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringMatch("FooBa", "FooBar", kStringCaseInsensitiveMatch));
VerifyOrQuit(!StringMatch("Fooba", "fooBar", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringMatch("FooBar", "FOOBAR", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringMatch("FoobaR", "FooBar", kStringCaseInsensitiveMatch));
VerifyOrQuit(StringMatch("FOOBAR", "foobar", kStringCaseInsensitiveMatch));
printf(" -- PASS\n");
}
void TestStringToLowercase(void)
{
const uint16_t kMaxSize = 100;
const char kTestString[] = "!@#$%^&*()_+=[].,<>//;:\"'`~ \t\r\n";
const char kUppercaseString[] = "ABCDEFGHIJKLMNOPQRATUVWXYZABCDEFGHIJKLMNOPQRATUVWXYZ";
const char kLowercaseString[] = "abcdefghijklmnopqratuvwxyzabcdefghijklmnopqratuvwxyz";
char string[kMaxSize];
printf("\nTest 10: StringConvertToLowercase() function\n");
memcpy(string, kTestString, sizeof(kTestString));
StringConvertToLowercase(string);
VerifyOrQuit(memcmp(string, kTestString, sizeof(kTestString)) == 0);
StringConvertToUppercase(string);
VerifyOrQuit(memcmp(string, kTestString, sizeof(kTestString)) == 0);
memcpy(string, kUppercaseString, sizeof(kUppercaseString));
StringConvertToLowercase(string);
VerifyOrQuit(memcmp(string, kLowercaseString, sizeof(kLowercaseString)) == 0);
StringConvertToUppercase(string);
VerifyOrQuit(memcmp(string, kUppercaseString, sizeof(kUppercaseString)) == 0);
printf(" -- PASS\n");
}
@@ -214,7 +317,10 @@ int main(void)
ot::TestStringLength();
ot::TestUtf8();
ot::TestStringFind();
ot::TestStringStartsWith();
ot::TestStringEndsWith();
ot::TestStringMatch();
ot::TestStringToLowercase();
printf("\nAll tests passed.\n");
return 0;
}