string.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-String.
 *
 * StormByte-String original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-String source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte Base tree),
 * which remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-String is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-String. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/cstring.hxx>
#include <StormByte/string/visibility.h>
 
#include <compare>
#include <cstddef>
#include <functional>
#include <iterator>
#include <ostream>
#include <queue>
#include <string>
#include <string_view>
#include <vector>
 
namespace StormByte {
    namespace String {
        class WString;
 
        class STORMBYTE_STRING_PUBLIC String {
            public:
                using value_type = char;    
                using const_iterator = const char*; 
                using const_reverse_iterator = std::reverse_iterator<const_iterator>;   
 
                String() noexcept;
 
                explicit String(const char* str) noexcept;
 
                explicit String(std::string_view str) noexcept;
 
                explicit String(CString text) noexcept;
 
                explicit String(const WString& other) noexcept;
 
                String(const String& other) noexcept;
 
                String(String&& other) noexcept;
 
                ~String() noexcept = default;
 
                String& operator=(const String& other) noexcept;
 
                String& operator=(String&& other) noexcept;
 
                inline const_iterator begin() const noexcept {
                    return data();
                }
 
                inline const_iterator end() const noexcept {
                    const char* text = data();
                    return text ? text + size() : nullptr;
                }
 
                inline const_iterator cbegin() const noexcept {
                    return begin();
                }
 
                inline const_iterator cend() const noexcept {
                    return end();
                }
 
                inline const_reverse_iterator rbegin() const noexcept {
                    return const_reverse_iterator(end());
                }
 
                inline const_reverse_iterator rend() const noexcept {
                    return const_reverse_iterator(begin());
                }
 
                inline const_reverse_iterator crbegin() const noexcept {
                    return rbegin();
                }
 
                inline const_reverse_iterator crend() const noexcept {
                    return rend();
                }
 
                inline const char* data() const noexcept {
                    return static_cast<const char*>(m_text);
                }
 
                inline std::size_t size() const noexcept {
                    return m_text.Length();
                }
 
                inline std::size_t length() const noexcept {
                    return size();
                }
 
                inline bool empty() const noexcept {
                    return size() == 0;
                }
 
                inline char operator[](std::size_t index) const noexcept {
                    return m_text[index];
                }
 
                inline explicit operator bool() const noexcept {
                    return static_cast<bool>(m_text);
                }
 
                inline operator std::string_view() const noexcept {
                    return static_cast<std::string_view>(m_text);
                }
 
                inline explicit operator std::string() const {
                    return static_cast<std::string>(m_text);
                }
 
                inline explicit operator const char*() const noexcept {
                    return static_cast<const char*>(m_text);
                }
 
                explicit operator WString() const noexcept;
 
                inline const CString& Bytes() const noexcept {
                    return m_text;
                }
 
                static String ToLower(std::string_view str) noexcept;
 
                static String ToUpper(std::string_view str) noexcept;
 
                static String SanitizeNewlines(std::string_view str) noexcept;
 
                static String RemoveWhitespace(std::string_view str) noexcept;
 
                static bool IsInteger(std::string_view str) noexcept;
 
                static void Split(std::string_view str, std::vector<String>& out) noexcept;
 
                static void Explode(std::string_view str, char delimiter, std::queue<String>& out) noexcept;
 
                inline String ToLower() const noexcept {
                    return ToLower(static_cast<std::string_view>(*this));
                }
 
                inline String ToUpper() const noexcept {
                    return ToUpper(static_cast<std::string_view>(*this));
                }
 
                inline String SanitizeNewlines() const noexcept {
                    return SanitizeNewlines(static_cast<std::string_view>(*this));
                }
 
                inline String RemoveWhitespace() const noexcept {
                    return RemoveWhitespace(static_cast<std::string_view>(*this));
                }
 
                inline bool IsInteger() const noexcept {
                    return IsInteger(static_cast<std::string_view>(*this));
                }
 
                inline std::vector<String> Split() const noexcept {
                    std::vector<String> out;
                    Split(static_cast<std::string_view>(*this), out);
                    return out;
                }
 
                inline std::queue<String> Explode(char delimiter) const noexcept {
                    std::queue<String> out;
                    Explode(static_cast<std::string_view>(*this), delimiter, out);
                    return out;
                }
 
                inline bool operator==(const String& other) const noexcept {
                    return m_text == other.m_text;
                }
 
                inline bool operator!=(const String& other) const noexcept {
                    return !(*this == other);
                }
 
                inline bool operator==(const char* str) const noexcept {
                    return m_text == str;
                }
 
                inline bool operator!=(const char* str) const noexcept {
                    return !(*this == str);
                }
 
                inline std::strong_ordering operator<=>(const String& other) const noexcept {
                    return m_text <=> other.m_text;
                }
 
                inline std::strong_ordering operator<=>(const char* str) const noexcept {
                    return m_text <=> str;
                }
 
                void swap(String& other) noexcept;
 
            private:
                CString m_text; 
        };
 
        inline std::ostream& operator<<(std::ostream& stream, const String& text) {
            return stream << text.Bytes();
        }
 
        inline bool operator==(const char* str, const String& text) noexcept {
            return text == str;
        }
 
        inline bool operator!=(const char* str, const String& text) noexcept {
            return text != str;
        }
 
        inline void swap(String& left, String& right) noexcept {
            left.swap(right);
        }
    }
}
 
template<>
struct std::hash<StormByte::String::String> {
    std::size_t operator()(const StormByte::String::String& text) const noexcept {
        return std::hash<std::string_view>{}(static_cast<std::string_view>(text));
    }
};