feat: String::split function (#120)

* feat: add string split function * test: add a few more test cases * chore: change comment a little * style: formatting --------- Co-authored-by: vishwa2710 <[email protected]>
open-space-collective · Jun 23, 2023 · c370cf4 · c370cf4
1 parent 58f780a
commit c370cf4
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/include/OpenSpaceToolkit/Core/Types/String.hpp b/include/OpenSpaceToolkit/Core/Types/String.hpp
@@ -18,11 +18,20 @@ namespace ostk
 {
 namespace core
 {
+
+// Forward declare Array to avoid circular dependency
+namespace ctnr
+{
+template <typename T>
+class Array;
+}
+
 namespace types
 {
 
 using ostk::core::types::Index;
 using ostk::core::types::Size;
+using ostk::core::ctnr::Array;
 
 /// @brief                      A sequence of characters
 /// @note                       The current implementation (derived for std::string) is temporary, as this type of
@@ -68,6 +77,13 @@ class String : public std::string
 
     String getSubstring(const Index& aStartPosition, const Size& aLength) const;
 
+    /// @brief              Split the String into tokens separated by the given delimeter.
+    ///                     E.X. String("1sat2satredsatbluesat").split("sat") -> ["1", "2", "red", "blue", ""]
+    ///
+    /// @return             Array of String tokens
+
+    Array<String> split(const String& aDelimiter) const;
+
     /// @brief              Removes whitespace from both ends
     ///
     /// @return             Reference to string

diff --git a/src/OpenSpaceToolkit/Core/Types/String.cpp b/src/OpenSpaceToolkit/Core/Types/String.cpp
@@ -2,6 +2,7 @@
 
 #include <boost/algorithm/string.hpp>
 
+#include <OpenSpaceToolkit/Core/Containers/Array.hpp>
 #include <OpenSpaceToolkit/Core/Error.hpp>
 #include <OpenSpaceToolkit/Core/Types/Integer.hpp>
 #include <OpenSpaceToolkit/Core/Types/String.hpp>
@@ -143,6 +144,13 @@ String String::getSubstring(const Index& aStartPosition, const Size& aLength) co
     return this->substr(aStartPosition, aLength);
 }
 
+Array<String> String::split(const String& aDelimiter) const
+{
+    Array<String> result;
+    boost::split(result, *this, boost::is_any_of(aDelimiter));
+    return result;
+}
+
 String& String::trim()
 {
     if (!this->empty())

diff --git a/test/OpenSpaceToolkit/Core/Types/String.test.cpp b/test/OpenSpaceToolkit/Core/Types/String.test.cpp
@@ -1,5 +1,6 @@
 /// Apache License 2.0
 
+#include <OpenSpaceToolkit/Core/Containers/Array.hpp>
 #include <OpenSpaceToolkit/Core/Types/Integer.hpp>
 #include <OpenSpaceToolkit/Core/Types/Real.hpp>
 #include <OpenSpaceToolkit/Core/Types/String.hpp>
@@ -167,6 +168,24 @@ TEST(OpenSpaceToolkit_Core_Types_String, GetSubstring)
     }
 }
 
+TEST(OpenSpaceToolkit_Core_Types_String, Split)
+{
+    using ostk::core::types::String;
+    using ostk::core::ctnr::Array;
+
+    {
+        EXPECT_EQ(Array<String>({"a", "b", "c", ""}), String("a,b,c,").split(","));
+        EXPECT_EQ(Array<String>({"", "a", "b", "c"}), String(",a,b,c").split(","));
+        EXPECT_EQ(Array<String>({"abc"}), String("abc").split(","));
+        EXPECT_EQ(Array<String>({"a", "c"}), String("abc").split("b"));
+        EXPECT_EQ(Array<String>({"a,b", "", "c", "", ""}), String("a,b  c  ").split(" "));
+        EXPECT_EQ(Array<String>({"ab", "c"}), String("ab\nc").split("\n"));
+        EXPECT_EQ(Array<String>({"", "", "", ""}), String("abc").split("abcd"));
+        EXPECT_EQ(Array<String>({""}), String("").split("\n"));
+        EXPECT_EQ(Array<String>({"abc"}), String("abc").split(""));
+    }
+}
+
 TEST(OpenSpaceToolkit_Core_Types_String, Trim)
 {
     using ostk::core::types::String;