container.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/config/exception.hxx>
#include <StormByte/config/item/base.hxx>
#include <StormByte/config/typedefs.hxx>
#include <StormByte/size.hxx>
#include <StormByte/string/string.hxx>
 
#include <queue>
#include <span>
#include <string_view>
#include <vector>
 
namespace StormByte::Config::Item {
    class STORMBYTE_CONFIG_PUBLIC Container: public Base {
        public:
            Container();
 
            Container(const StormByte::String::String& name);
 
            Container(StormByte::String::String&& name);
 
            Container(const Container& base);
 
            Container(Container&& base) noexcept;
 
            Container& operator=(const Container& base);
 
            Container& operator=(Container&& base) noexcept;
 
            virtual ~Container() noexcept override;
            bool Equals(const Base& other) const noexcept override;
 
            Base& operator[](const StormByte::Size& index);
 
            const Base& operator[](const StormByte::Size& index) const;
 
            Base& operator[](const StormByte::String::String& path);
 
            inline const Base& operator[](const StormByte::String::String& path) const {
                return LookUp(path);
            }
 
            inline Base& operator[](std::string_view path) {
                return operator[](StormByte::String::String(path));
            }
 
            inline const Base& operator[](std::string_view path) const {
                return operator[](StormByte::String::String(path));
            }
 
            bool operator==(const Container& container) const noexcept;
 
            inline bool operator!=(const Container& container) const noexcept {
                return !operator==(container);
            }
 
            StormByte::String::String Serialize(const int& indent_level) const noexcept override;
 
            static constexpr std::pair<const char, const char> EnclosureCharacters(const ContainerType& type) noexcept {
                switch (type) {
                    case ContainerType::Group: return {'{', '}'};
                    case ContainerType::List:  return {'[', ']'};
                    default:                   return {'\0', '\0'};
                }
            }
 
            static constexpr const char EndCharacter(const ContainerType& type) noexcept {
                switch (type) {
                    case ContainerType::Group: return '}';
                    case ContainerType::List:  return ']';
                    default:                   return '\0';
                }
            }
 
            constexpr virtual Item::ContainerType ContainerType() const noexcept = 0;
 
            constexpr std::string_view ContainerTypeToString() const noexcept {
                return Item::TypeToString(this->ContainerType());
            }
 
            constexpr Item::Type Type() const noexcept override {
                return Item::Type::Container;
            }
            inline Base& Add(const Base& item, const StormByte::Config::OnExistingAction& on_existing) {
                return Add(std::move(*item.Clone()), on_existing);
            }
 
            inline Base& Add(Base&& item, const StormByte::Config::OnExistingAction& on_existing) {
                return Add(item.Move(), on_existing);
            }
 
            inline Base& Add(const Base& item) {
                return Add(std::move(*item.Clone()), m_on_existing_action);
            }
 
            inline Base& Add(Base&& item) {
                return Add(item.Move(), m_on_existing_action);
            }
 
            inline Base& Add(Base::PointerType item) {
                return Add(item, m_on_existing_action);
            }
 
            Base& Add(Base::PointerType item, const StormByte::Config::OnExistingAction& on_existing);
 
            void Clear() noexcept;
 
            bool Exists(const StormByte::String::String& path) const;
 
            inline bool Exists(std::string_view path) const {
                return Exists(StormByte::String::String(path));
            }
 
            void Remove(const StormByte::Size& index);
 
            void Remove(const StormByte::String::String& path);
 
            inline void Remove(std::string_view path) {
                Remove(StormByte::String::String(path));
            }
 
            constexpr std::span<const Base::PointerType> Items() noexcept {
                return std::span<const Base::PointerType>(m_items);
            }
 
            constexpr std::span<const Base::PointerType> Items() const noexcept {
                return std::span<const Base::PointerType>(m_items);
            }
 
            StormByte::Size Size() const noexcept;
 
            StormByte::Size Count() const noexcept;
            void SetOnExistingAction(StormByte::Config::OnExistingAction action) noexcept {
                m_on_existing_action = action;
            }
 
            StormByte::Config::OnExistingAction GetOnExistingAction() const noexcept {
                return m_on_existing_action;
            }
        protected:
            std::vector<Base::PointerType> m_items; 
            StormByte::Config::OnExistingAction m_on_existing_action = StormByte::Config::OnExistingAction::ThrowException; 
 
            virtual Base::PointerType BeforeAdditionActions(Base::PointerType item, const StormByte::Config::OnExistingAction onexisting) = 0;
 
        private:
            virtual StormByte::String::String ContentsToString(const int& level) const noexcept;
 
            static bool IsPathValid(const StormByte::String::String& name) noexcept;
 
            const Base& LookUp(const StormByte::String::String& path) const;
 
            const Base& LookUp(std::queue<StormByte::String::String>& path) const;
 
            void Remove(std::queue<StormByte::String::String>& path);
    };
}