cstring.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte.
 *
 * StormByte 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 source in this repository.
 * They do not cover other StormByte modules or any third-party material
 * shipped with this repository (including everything under thirdparty/),
 * 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 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. 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/visibility.h>
 
#include <compare>
#include <cstddef>
#include <functional>
#include <ostream>
#include <string>
#include <string_view>
 
namespace StormByte {
    class STORMBYTE_PUBLIC CString {
        public:
            CString() noexcept;
 
            explicit CString(const char* str) noexcept;
 
            CString(const CString& other) noexcept;
 
            CString(CString&& other) noexcept;
 
            ~CString() noexcept;
 
            CString& operator=(const CString& other) noexcept;
 
            CString& operator=(CString&& other) noexcept;
 
            void Reset(const char* str = nullptr) noexcept;
 
            void swap(CString& other) noexcept;
 
            std::size_t Length() const noexcept;
 
            char operator[](std::size_t index) const noexcept;
 
            inline explicit operator bool() const noexcept {
                return static_cast<const char*>(*this) != nullptr;
            }
 
            explicit operator const char*() const noexcept;
 
            inline explicit operator std::string_view() const noexcept {
                const char* text = static_cast<const char*>(*this);
                return text ? std::string_view(text) : std::string_view();
            }
 
            inline operator std::string() const {
                const char* text = static_cast<const char*>(*this);
                return text ? std::string(text) : std::string();
            }
 
            inline std::ostream& operator<<(std::ostream& stream) const {
                const char* text = static_cast<const char*>(*this);
                if (text)
                    stream << text;
                return stream;
            }
 
            bool operator==(const CString& other) const noexcept;
 
            bool operator!=(const CString& other) const noexcept {
                return !(*this == other);
            }
 
            bool operator==(const char* str) const noexcept;
 
            bool operator!=(const char* str) const noexcept {
                return !(*this == str);
            }
 
            std::strong_ordering operator<=>(const CString& other) const noexcept;
 
            std::strong_ordering operator<=>(const char* str) const noexcept;
 
        private:
            const char* m_data; 
 
            static const char* Duplicate(const char* str) noexcept;
    };
 
    inline std::ostream& operator<<(std::ostream& stream, const CString& text) {
        return text.operator<<(stream);
    }
 
    inline bool operator==(const char* str, const CString& text) noexcept {
        return text == str;
    }
 
    inline bool operator!=(const char* str, const CString& text) noexcept {
        return text != str;
    }
 
    inline void swap(CString& left, CString& right) noexcept {
        left.swap(right);
    }
}
 
template<>
struct std::hash<StormByte::CString> {
    std::size_t operator()(const StormByte::CString& text) const noexcept {
        const char* raw = static_cast<const char*>(text);
        if (!raw)
            return 0;
        return std::hash<std::string_view>{}(raw);
    }
};