container.hxx

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Config.
 *
 * StormByte-Config is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * 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
 * along with StormByte-Config. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
#include <StormByte/config/exception.hxx>
#include <StormByte/config/item/base.hxx>
#include <StormByte/config/typedefs.hxx>
 
#include <queue>
#include <span>
#include <vector>
 
namespace StormByte::Config::Item {
    class STORMBYTE_CONFIG_PUBLIC Container: public Base {
        public:
            Container() = default;
 
            Container(const std::string& name);
 
            Container(std::string&& name);
 
            Container(const Container& base) = default;
 
            Container(Container&& base) noexcept = default;
 
            Container& operator=(const Container& base) = default;
 
            Container& operator=(Container&& base) noexcept = default;
 
            virtual ~Container() noexcept override = default;
            bool Equals(const Base& other) const noexcept override;
 
            Base& operator[](const size_t& index);
 
            const Base& operator[](const size_t& index) const;
 
            Base& operator[](const std::string& path);
 
            inline const Base& operator[](const std::string& path) const {
                return LookUp(path);
            }
 
            bool operator==(const Container& container) const noexcept;
 
            inline bool operator!=(const Container& container) const noexcept {
                return !operator==(container);
            }
 
            std::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 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);
            }
 
            Base& Add(Base::PointerType item, const StormByte::Config::OnExistingAction& on_existing);
 
            inline void Clear() noexcept {
                m_items.clear();
            }
 
            bool Exists(const std::string& path) const;
 
            void Remove(const size_t& index);
 
            void Remove(const std::string& path);
 
            constexpr std::span<Base::PointerType> Items() noexcept {
                return std::span(m_items);
            }
 
            constexpr std::span<const Base::PointerType> Items() const noexcept {
                return std::span(m_items);
            }
 
            constexpr size_t Size() const noexcept {
                return m_items.size();
            }
 
            size_t 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 std::string ContentsToString(const int& level) const noexcept;
 
            static bool IsPathValid(const std::string& name) noexcept;
 
            const Base& LookUp(const std::string& path) const;
 
            const Base& LookUp(std::queue<std::string>& path) const;
 
            void Remove(std::queue<std::string>& path);
    };
}