PoolFactory.h

/*
 * Copyright (C) 2025, Robert Patterson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <functional>
#include <memory>
#include <stdexcept>
#include <string>
#include <string_view>
#include <type_traits>
 
#include "musx/dom/Document.h"
#include "musx/dom/ObjectPool.h"
#include "musx/xml/XmlInterface.h"
#include "musx/factory/ConstructionContext.h"
 
namespace musx {
namespace factory {
 
using NodeFilter = std::function<bool(const xml::XmlElementPtr&)>;
 
class PartSharingFactory
{
public:
    template <typename T>
    static void initializePartial(const std::shared_ptr<T>& partInstance,
                                  const std::shared_ptr<const T>& scoreInstance)
    {
        static_assert(std::is_base_of_v<dom::EnigmaBase, T>, "T must derive from EnigmaBase");
        MUSX_ASSERT_IF(!partInstance || !scoreInstance) {
            throw std::invalid_argument("Partial sharing requires both score and part instances.");
        }
        MUSX_ASSERT_IF(partInstance->getShareMode() != dom::EnigmaBase::ShareMode::Partial) {
            throw std::invalid_argument("Invalid score/part instances for partial sharing.");
        }
        *partInstance = *scoreInstance;
        dom::PartContextRebinder<T>::rebind(partInstance);
    }
};
 
class OptionsFactory
{
public:
    [[nodiscard]] static dom::OptionsPoolPtr create(
        ConstructionContext& context, const xml::XmlElementPtr& element, const dom::DocumentPtr& document,
        const NodeFilter& filter = {});
};
 
class OthersFactory
{
public:
    [[nodiscard]] static dom::OthersPoolPtr create(
        ConstructionContext& context, const xml::XmlElementPtr& element, const dom::DocumentPtr& document,
        const NodeFilter& filter = {});
};
 
class DetailsFactory
{
public:
    [[nodiscard]] static dom::DetailsPoolPtr create(
        ConstructionContext& context, const xml::XmlElementPtr& element, const dom::DocumentPtr& document,
        const NodeFilter& filter = {});
};
 
class EntryFactory
{
public:
    [[nodiscard]] static dom::EntryPoolPtr create(
        ConstructionContext& context, const xml::XmlElementPtr& element, const dom::DocumentPtr& document,
        const NodeFilter& filter = {});
};
 
class TextsFactory
{
public:
    [[nodiscard]] static dom::TextsPoolPtr create(
        ConstructionContext& context, const xml::XmlElementPtr& element, const dom::DocumentPtr& document,
        const NodeFilter& filter = {});
};
 
} // namespace factory
} // namespace musx