wcstring.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 <cwchar>
#include <functional>
#include <ostream>
#include <string>
#include <string_view>
 
namespace StormByte {
    class Size;
 
    namespace Safe {
        class CString;
 
        class STORMBYTE_PUBLIC WCString final {
            public:
                WCString() noexcept;
 
                explicit WCString(const wchar_t* str) noexcept;
 
                explicit WCString(std::wstring_view sv) noexcept;
 
                explicit WCString(const std::wstring& str) noexcept;
 
                explicit WCString(const CString& text) noexcept;
 
                WCString(const WCString& other) noexcept;
 
                WCString(WCString&& other) noexcept;
 
                ~WCString() noexcept;
 
                WCString& operator=(const WCString& other) noexcept;
 
                WCString& operator=(WCString&& other) noexcept;
 
                void Reset(const wchar_t* str = nullptr) noexcept;
 
                void swap(WCString& other) noexcept;
 
                Size Length() const noexcept;
 
                wchar_t operator[](const Size& index) const noexcept;
 
                inline explicit operator bool() const noexcept {
                    return static_cast<const wchar_t*>(*this) != nullptr;
                }
 
                explicit operator const wchar_t*() const noexcept;
 
                inline explicit operator std::wstring_view() const noexcept {
                    const wchar_t* text = static_cast<const wchar_t*>(*this);
                    return text ? std::wstring_view(text) : std::wstring_view();
                }
 
                STORMBYTE_FORCE_INLINE operator std::wstring() const {
                    const wchar_t* text = static_cast<const wchar_t*>(*this);
                    return text ? std::wstring(text) : std::wstring();
                }
 
                STORMBYTE_FORCE_INLINE std::wostream& operator<<(std::wostream& stream) const {
                    const wchar_t* text = static_cast<const wchar_t*>(*this);
                    if (text)
                        stream << text;
                    return stream;
                }
 
                bool operator==(const WCString& other) const noexcept;
 
                bool operator!=(const WCString& other) const noexcept {
                    return !(*this == other);
                }
 
                bool operator==(const wchar_t* str) const noexcept;
 
                bool operator!=(const wchar_t* str) const noexcept {
                    return !(*this == str);
                }
 
                std::strong_ordering operator<=>(const WCString& other) const noexcept;
 
                std::strong_ordering operator<=>(const wchar_t* str) const noexcept;
 
            private:
                const wchar_t* m_data;  
 
                static const wchar_t* Duplicate(const wchar_t* str) noexcept;
 
                static const wchar_t* Duplicate(std::wstring_view sv) noexcept;
        };
 
        inline std::wostream& operator<<(std::wostream& stream, const WCString& text) {
            return text.operator<<(stream);
        }
 
        inline bool operator==(const wchar_t* str, const WCString& text) noexcept {
            return text == str;
        }
 
        inline bool operator!=(const wchar_t* str, const WCString& text) noexcept {
            return text != str;
        }
 
        inline void swap(WCString& left, WCString& right) noexcept {
            left.swap(right);
        }
    }
}
 
#include <StormByte/size.hxx>
 
template<>
struct std::hash<StormByte::Safe::WCString> {
    std::size_t operator()(const StormByte::Safe::WCString& text) const noexcept {
        const wchar_t* raw = static_cast<const wchar_t*>(text);
        if (!raw)
            return 0;
        return std::hash<std::wstring_view>{}(raw);
    }
};