tb_string_utilities.hpp

 
#ifndef TurtleBrains_StringUtilities_hpp
#define TurtleBrains_StringUtilities_hpp
 
#include <turtle_brains/core/tb_string.hpp>
 
namespace TurtleBrains::Core::StringUtilities
{
    // 2024-11-21: There is almost a certainty that String is getting renamed String, which is conflicting with
    //   this namespace. This should probably be named StringUtilities to match FileUtilties/SystemUtilities etc...
    //   ikiwixz suggests the String could also move directly into the TurtleBrains namespace. This would suggest
    //   that String type is extremely Core to TurtleBrains, but it would allow Game/Application and other areas to
    //   still use it as String instead of Core::String.
    //
    //   For years I felt tbCore::String tbMath::Vector3 etc was the better approach since it clearly identified
    //   where the type lived, and I still think there is truth to that, but after testing typedefs in TrophyBrawlers
    //   where the game types are String, Vector3, iceVector3 etc it shortened lines of code considerably without
    //   negative impact.
    //
    // 2025-10-07: Consider "String::function" deprecated and start using StringUtilities in any new code.
 
    inline bool StringContains(const String& input, const String& contents)
    {
        return (String::npos == input.find(contents)) ? false : true;
    }
 
    inline bool StringStartsWith(const String& input, const String& contents)
    {
        return (0 == input.find(contents)) ? true : false;
    }
 
    bool IsOnlyWhitespace(const String& input);
 
    String ExtendedAsciiToUTF8(const String& input);
 
    String TrimWhitespace(String contents);
 
    String TrimLeadingWhitespace(String contents);
 
    String TrimTrailingWhitespace(String contents);
 
    String& TrimWhitespaceInPlace(String& contents);
    String& TrimLeadingWhitespaceInPlace(String& contents);
    String& TrimTrailingWhitespaceInPlace(String& contents);
 
    String Lowercase(const String& contents);
    String& LowercaseInPlace(String& contents);
    String Uppercase(const String& contents);
    String& UppercaseInPlace(String& contents);
 
    String ReplaceFirstInstanceOf(const String& contents, const String& token, const String& replace);
    String ReplaceAllInstancesOf(const String& contents, const String& token, const String& replace);
 
    bool StartsWith(const String& stringToSearch, const String& expectedStart);
 
    std::vector<std::string> SeparateString(const std::string& original, const std::string& token = " ");
    std::vector<std::string> SeparateString(const std::string& original, const std::vector<std::string>& tokens);
 
    inline std::vector<std::string> SeparateString(const std::string& original, const std::initializer_list<std::string>& tokens)
    {
        return SeparateString(original, std::vector<std::string>(tokens));
    }
 
    String LocalDateTimeToString(void);
 
    //235959
    String LocalTimeToString(void);
 
    //20190131
    String LocalDateToString(void);
 
    String TimeToString(const tbCore::uint32& timeInMilliseconds, const bool showMilliseconds = true, const bool forceMinutes = true);
    String TimeToHourMinuteString(const tbCore::uint32& timeInMilliseconds);
 
}; /* namespace TurtleBrains::Core::StringUtilities */
 
namespace tbCore = TurtleBrains::Core;
 
#endif /* TurtleBrains_StringUtilities_hpp */