base.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Config.
 *
 * StormByte-Config 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-Config 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-String tree and
 * the StormByte Base tree it vendors), 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-Config 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-Config. 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/clonable.hxx>
#include <StormByte/config/exception.hxx>
#include <StormByte/config/item/type.hxx>
#include <StormByte/config/visibility.h>
#include <StormByte/string/string.hxx>
 
#include <string_view>
 
namespace StormByte::Config::Item {
    class Container;
    class Group;
    class List;
    class Value;
    template<CommentType T> class Comment;
 
    class STORMBYTE_CONFIG_PUBLIC Base: public Clonable<Base, StormByte::Shared<Base>> {
        public:
            Base() noexcept;
 
            Base(const StormByte::String::String& name);
 
            Base(const Base& base) noexcept = default;
 
            Base(Base&& base) noexcept = default;
 
            Base& operator=(const Base& base) noexcept = default;
 
            Base& operator=(Base&& base) noexcept = default;
 
            ~Base() noexcept override;
 
            bool operator==(const Base& base) const noexcept;
 
            bool operator!=(const Base& base) const noexcept;
 
            constexpr const StormByte::String::String& Name() const noexcept {
                return m_name;
            }
 
            constexpr void Name(const StormByte::String::String& name) {
                m_name = name;
            }
 
            void Name(std::string_view name);
 
            constexpr virtual Item::Type Type() const noexcept = 0;
 
            constexpr std::string_view TypeToString() const noexcept {
                return Item::TypeToString(this->Type());
            }
 
            static bool IsNameValid(const StormByte::String::String& name) noexcept;
 
            static bool IsNameValid(std::string_view name) noexcept;
 
            template<class T> decltype(auto) As();
 
            template<class T> decltype(auto) As() const;
 
            virtual StormByte::String::String Serialize(const int& indent_level = 0) const;
 
        protected:
            StormByte::String::String m_name; 
 
            virtual bool Equals(const Base& base) const = 0;
    };
}