Skip to content

Commit

Permalink
Rename functions appropriately
Browse files Browse the repository at this point in the history
  • Loading branch information
@dr8co
dr8co committed Apr 11, 2024
1 parent 275d3a7 commit da8c344
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 42 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,22 +232,22 @@ bool string_swap(lite_string *const restrict s1, lite_string *const restrict s2)
### Search

```c
size_t string_find_substr_from(const lite_string *const restrict s, const lite_string *const restrict sub, const size_t start)
size_t string_find_from(const lite_string *const restrict s, const lite_string *const restrict sub, const size_t start)
// Finds the first occurrence of a substring in a string, starting from a specified index.

size_t string_find_substr(const lite_string *const restrict s, const lite_string *const restrict sub)
size_t string_find(const lite_string *const restrict s, const lite_string *const restrict sub)
// Finds the first occurrence of a substring in a string.

size_t string_rfind_substr(const lite_string *const restrict s, const lite_string *const restrict sub)
size_t string_rfind(const lite_string *const restrict s, const lite_string *const restrict sub)
// Finds the last occurrence of a substring in a string.

size_t string_find_substr_cstr_from(const lite_string *const restrict s, const char *const restrict cstr, const size_t start)
size_t string_find_cstr_from(const lite_string *const restrict s, const char *const restrict cstr, const size_t start)
// Finds the first occurrence of a C-string in a string, starting from a specified index.

size_t string_rfind_substr_cstr(const lite_string *const restrict s, const char *const restrict cstr)
size_t string_rfind_cstr(const lite_string *const restrict s, const char *const restrict cstr)
// Finds the last occurrence of a C-string in a string.

size_t string_find_substr_cstr(const lite_string *const restrict s, const char *const restrict cstr)
size_t string_find_cstr(const lite_string *const restrict s, const char *const restrict cstr)
// Finds the first occurrence of a C-string in a string.

size_t string_find_last_of(const lite_string *const restrict s, const char c)
Expand Down
2 changes: 1 addition & 1 deletion examples/cheap_grep.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ int cheap_grep(const lite_string *pattern, std::istream &input, bool ignoreCase)

if (ignoreCase) string_to_lower(lineCopy.get());

if (string_find_substr(lineCopy.get(), patternCopy.get()) != SIZE_MAX) {
if (string_find(lineCopy.get(), patternCopy.get()) != SIZE_MAX) {
ret = 0;
std::cout << line << '\n';
}
Expand Down
28 changes: 14 additions & 14 deletions lite_string.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,7 @@ bool string_contains_char(const lite_string *const restrict s, const char c) {
* @param start The index from which the search will start.
* @return The index of the first occurrence of the substring in the string, or \p SIZE_MAX if the substring was not found.
*/
size_t string_find_substr_from(const lite_string *const restrict s, const lite_string *const restrict sub,
size_t string_find_from(const lite_string *const restrict s, const lite_string *const restrict sub,
const size_t start) {
if (s && sub && start < s->size) {
if (sub->size == 0) return start;
Expand Down Expand Up @@ -787,8 +787,8 @@ size_t string_find_substr_from(const lite_string *const restrict s, const lite_s
* @param sub A pointer to the substring to be found.
* @return The index of the first occurrence of the substring in the string, or \p SIZE_MAX if the substring was not found.
*/
size_t string_find_substr(const lite_string *const restrict s, const lite_string *const restrict sub) {
return string_find_substr_from(s, sub, 0);
size_t string_find(const lite_string *const restrict s, const lite_string *const restrict sub) {
return string_find_from(s, sub, 0);
}

/**
Expand All @@ -798,7 +798,7 @@ size_t string_find_substr(const lite_string *const restrict s, const lite_string
* @param sub A pointer to the substring to be found.
* @return The index of the last occurrence of the substring in the string, or \p SIZE_MAX if the substring was not found.
*/
size_t string_rfind_substr(const lite_string *const restrict s, const lite_string *const restrict sub) {
size_t string_rfind(const lite_string *const restrict s, const lite_string *const restrict sub) {
if (s && sub) {
if (sub->size == 0) return s->size;
if (sub->size > s->size) return SIZE_MAX;
Expand Down Expand Up @@ -827,7 +827,7 @@ size_t string_rfind_substr(const lite_string *const restrict s, const lite_strin
* @param start The index from which the search will start.
* @return The index of the first occurrence of the C-string in the string, or \p SIZE_MAX if the C-string was not found.
*/
size_t string_find_substr_cstr_from(const lite_string *const restrict s, const char *const restrict cstr,
size_t string_find_cstr_from(const lite_string *const restrict s, const char *const restrict cstr,
const size_t start) {
// The string and the C-string must be valid
if (s && cstr) {
Expand Down Expand Up @@ -865,7 +865,7 @@ size_t string_find_substr_cstr_from(const lite_string *const restrict s, const c
* @param cstr The C-string to be found.
* @return The index of the last occurrence of the C-string in the string, or \p SIZE_MAX if the C-string was not found.
*/
size_t string_rfind_substr_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
size_t string_rfind_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
if (s && cstr) {
const size_t len = strlen(cstr);
if (len == 0) return s->size;
Expand Down Expand Up @@ -894,8 +894,8 @@ size_t string_rfind_substr_cstr(const lite_string *const restrict s, const char
* @param cstr The C-string to be found.
* @return The index of the first occurrence of the C-string in the string, or \p SIZE_MAX if the C-string was not found.
*/
size_t string_find_substr_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
return string_find_substr_cstr_from(s, cstr, 0);
size_t string_find_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
return string_find_cstr_from(s, cstr, 0);
}

/**
Expand All @@ -906,7 +906,7 @@ size_t string_find_substr_cstr(const lite_string *const restrict s, const char *
* @return True if the string contains the substring, false otherwise.
*/
bool string_contains(const lite_string *const restrict s, const lite_string *const restrict sub) {
return string_find_substr(s, sub) != SIZE_MAX;
return string_find(s, sub) != SIZE_MAX;
}

/**
Expand All @@ -917,7 +917,7 @@ bool string_contains(const lite_string *const restrict s, const lite_string *con
* @return True if the string contains the C-string, false otherwise.
*/
bool string_contains_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
return string_find_substr_cstr(s, cstr) != SIZE_MAX;
return string_find_cstr(s, cstr) != SIZE_MAX;
}

/**
Expand All @@ -928,7 +928,7 @@ bool string_contains_cstr(const lite_string *const restrict s, const char *const
* @return True if the string starts with the substring, false otherwise.
*/
bool string_starts_with(const lite_string *const restrict s, const lite_string *const restrict sub) {
return string_find_substr(s, sub) == 0;
return string_find(s, sub) == 0;
}

/**
Expand All @@ -939,7 +939,7 @@ bool string_starts_with(const lite_string *const restrict s, const lite_string *
* @return True if the string starts with the C-string, false otherwise.
*/
bool string_starts_with_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
return string_find_substr_cstr(s, cstr) == 0;
return string_find_cstr(s, cstr) == 0;
}

/**
Expand All @@ -950,7 +950,7 @@ bool string_starts_with_cstr(const lite_string *const restrict s, const char *co
* @return True if the string ends with the substring, false otherwise.
*/
bool string_ends_with(const lite_string *const restrict s, const lite_string *const restrict sub) {
return s && sub && string_rfind_substr(s, sub) == s->size - sub->size;
return s && sub && string_rfind(s, sub) == s->size - sub->size;
}

/**
Expand All @@ -961,7 +961,7 @@ bool string_ends_with(const lite_string *const restrict s, const lite_string *co
* @return True if the string ends with the C-string, false otherwise.
*/
bool string_ends_with_cstr(const lite_string *const restrict s, const char *const restrict cstr) {
return s && cstr && string_rfind_substr_cstr(s, cstr) == s->size - strlen(cstr);
return s && cstr && string_rfind_cstr(s, cstr) == s->size - strlen(cstr);
}


Expand Down
18 changes: 11 additions & 7 deletions lite_string.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ bool string_append(lite_string *restrict s1, const lite_string *restrict s2);

bool string_append_cstr(lite_string *restrict s, const char *restrict cstr);

[[nodiscard]] char *string_cstr(const lite_string *restrict s);
char *string_cstr(lite_string *restrict s);

bool string_compare_cstr(const lite_string *restrict s, const char *restrict cstr);

Expand Down Expand Up @@ -136,17 +136,17 @@ size_t string_find_first_of(const lite_string *restrict s, char c);

size_t string_find_first_not_of(const lite_string *restrict s, char c);

size_t string_find_substr_from(const lite_string *restrict s, const lite_string *restrict sub, size_t start);
size_t string_find_from(const lite_string *restrict s, const lite_string *restrict sub, size_t start);

size_t string_find_substr(const lite_string *restrict s, const lite_string *restrict sub);
size_t string_find(const lite_string *restrict s, const lite_string *restrict sub);

size_t string_rfind_substr(const lite_string *restrict s, const lite_string *restrict sub);
size_t string_rfind(const lite_string *restrict s, const lite_string *restrict sub);

size_t string_find_substr_cstr_from(const lite_string *restrict s, const char *restrict cstr, size_t start);
size_t string_find_cstr_from(const lite_string *restrict s, const char *restrict cstr, size_t start);

size_t string_rfind_substr_cstr(const lite_string *restrict s, const char *restrict cstr);
size_t string_rfind_cstr(const lite_string *restrict s, const char *restrict cstr);

size_t string_find_substr_cstr(const lite_string *restrict s, const char *restrict cstr);
size_t string_find_cstr(const lite_string *restrict s, const char *restrict cstr);

bool string_contains_char(const lite_string *restrict s, char c);

Expand All @@ -166,6 +166,10 @@ bool string_shrink(lite_string *restrict s, size_t size);

bool string_shrink_to_fit(lite_string *restrict s);

void string_to_lower(const lite_string *restrict s);

[[nodiscard]] lite_string *string_new_cstr(const char *restrict cstr);

#if __cplusplus
}
#endif
28 changes: 14 additions & 14 deletions tests/testLiteString.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -348,13 +348,13 @@ TEST(LiteStringTest, FunctionsDoNotCrashForNullptr) {
EXPECT_EQ(string_find_first_of(nullptr, 'a'), SIZE_MAX);
EXPECT_EQ(string_find_first_not_of(nullptr, 'a'), SIZE_MAX);

EXPECT_EQ(string_find_substr_from(nullptr, nullptr, 17), SIZE_MAX);
EXPECT_EQ(string_find_substr(nullptr, nullptr), SIZE_MAX);
EXPECT_EQ(string_find_from(nullptr, nullptr, 17), SIZE_MAX);
EXPECT_EQ(string_find(nullptr, nullptr), SIZE_MAX);

EXPECT_EQ(string_rfind_substr(nullptr, nullptr), SIZE_MAX);
EXPECT_EQ(string_find_substr_cstr_from(nullptr, nullptr, 1900), SIZE_MAX);
EXPECT_EQ(string_rfind_substr_cstr(nullptr, nullptr), SIZE_MAX);
EXPECT_EQ(string_find_substr_cstr(nullptr, nullptr), SIZE_MAX);
EXPECT_EQ(string_rfind(nullptr, nullptr), SIZE_MAX);
EXPECT_EQ(string_find_cstr_from(nullptr, nullptr, 1900), SIZE_MAX);
EXPECT_EQ(string_rfind_cstr(nullptr, nullptr), SIZE_MAX);
EXPECT_EQ(string_find_cstr(nullptr, nullptr), SIZE_MAX);

EXPECT_FALSE(string_contains_char(nullptr, 'a'));
EXPECT_FALSE(string_contains(nullptr, nullptr));
Expand Down Expand Up @@ -574,7 +574,7 @@ TEST(LiteStringTest, FindSubstrFromFindsCorrectIndex) {
lite_string *sub = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World!"));
ASSERT_TRUE(string_append_cstr(sub, "World"));
EXPECT_EQ(string_find_substr_from(s, sub, 0), 7);
EXPECT_EQ(string_find_from(s, sub, 0), 7);
string_free(s);
string_free(sub);
}
Expand All @@ -584,7 +584,7 @@ TEST(LiteStringTest, FindSubstrFromReturnsMaxSize) {
lite_string *sub = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World!"));
ASSERT_TRUE(string_append_cstr(sub, "Planet"));
EXPECT_EQ(string_find_substr_from(s, sub, 0), SIZE_MAX);
EXPECT_EQ(string_find_from(s, sub, 0), SIZE_MAX);
string_free(s);
string_free(sub);
}
Expand All @@ -594,7 +594,7 @@ TEST(LiteStringTest, FindSubstrFindsCorrectIndex) {
lite_string *sub = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World!"));
ASSERT_TRUE(string_append_cstr(sub, "World"));
EXPECT_EQ(string_find_substr(s, sub), 7);
EXPECT_EQ(string_find(s, sub), 7);
string_free(s);
string_free(sub);
}
Expand All @@ -604,22 +604,22 @@ TEST(LiteStringTest, RFindSubstrFindsCorrectIndex) {
lite_string *sub = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World! World!"));
ASSERT_TRUE(string_append_cstr(sub, "World"));
EXPECT_EQ(string_rfind_substr(s, sub), 14);
EXPECT_EQ(string_rfind(s, sub), 14);
string_free(s);
string_free(sub);
}

TEST(LiteStringTest, FindSubstrCStrFromFindsCorrectIndex) {
lite_string *s = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World!"));
EXPECT_EQ(string_find_substr_cstr_from(s, "World", 0), 7);
EXPECT_EQ(string_find_cstr_from(s, "World", 0), 7);
string_free(s);
}

TEST(LiteStringTest, RFindSubstrCStrFindsCorrectIndex) {
lite_string *s = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World! World!"));
EXPECT_EQ(string_rfind_substr_cstr(s, "World"), 14);
EXPECT_EQ(string_rfind_cstr(s, "World"), 14);
string_free(s);
}

Expand All @@ -646,14 +646,14 @@ TEST(LiteStringTest, ContainsCharReturnsFalseForEmptyString) {
TEST(LiteStringTest, FindSubstrCStrReturnsCorrectIndex) {
lite_string *s = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World!"));
EXPECT_EQ(string_find_substr_cstr(s, "World"), 7);
EXPECT_EQ(string_find_cstr(s, "World"), 7);
string_free(s);
}

TEST(LiteStringTest, FindSubstrCStrReturnsMaxSize) {
lite_string *s = string_new();
ASSERT_TRUE(string_append_cstr(s, "Hello, World!"));
EXPECT_EQ(string_find_substr_cstr(s, "Planet"), SIZE_MAX);
EXPECT_EQ(string_find_cstr(s, "Planet"), SIZE_MAX);
string_free(s);
}

Expand Down

0 comments on commit da8c344

Please sign in to comment.