Document.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 <filesystem>
#include <fstream>
 
#include "BaseTypes.h"
#include "MnxdomProvenance.h"
#include "Global.h"
#include "Layout.h"
#include "Part.h"
#include "Score.h"
 
namespace mnx {
 
namespace util {
class EntityMap;
}
 
struct EntityMapPolicies
{
    bool ottavasRespectGraceTargets { true };
    bool ottavasRespectVoiceTargets { true };
};
 
class MnxMetaData : public Object
{
public:
    using Object::Object;
 
    MnxMetaData(Base& parent, std::string_view key)
        : Object(parent, key)
    {
        // required children
        set_version(getMnxSchemaVersion());
        auto extensions = ensure__x();
        MnxdomExtensionData(extensions, MNXDOM_PROVENANCE_KEY);
    }
 
    class Support : public Object
    {
    public:
        using Object::Object;
 
        MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, useAccidentalDisplay, false);  
        MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, useBeams, false);              
    };
 
    MNX_REQUIRED_PROPERTY(int, version);
 
    MNX_OPTIONAL_CHILD(Support, support);
 
    [[nodiscard]] std::optional<MnxdomExtensionData> mnxdom() const
    {
        if (const auto value = getExtension(std::string(MNXDOM_PROVENANCE_KEY)); value.has_value() && value->is_object()) {
            return MnxdomExtensionData(root(), pointer() / "_x" / std::string(MNXDOM_PROVENANCE_KEY));
        }
        return std::nullopt;
    }
 
    MnxdomExtensionData ensure_mnxdom()
    {
        if (auto existing = mnxdom()) {
            return *existing;
        }
 
        auto extensions = ensure__x();
        return MnxdomExtensionData(extensions, MNXDOM_PROVENANCE_KEY);
    }
 
    void clear_mnxdom()
    {
        clearExtension(std::string(MNXDOM_PROVENANCE_KEY));
        if (auto extensions = _x(); extensions && extensions->empty()) {
            clear__x();
        }
    }
};
 
class Document : public Object
{
private:
    std::shared_ptr<util::EntityMap> m_entityMapping;
 
public:
    Document() : Object()
    {
        // create required children
        create_mnx();
        create_global();
        create_parts();
    }
 
    Document(const std::shared_ptr<json>& root) : Object(root, json_pointer{}) {}
 
    Document(const Document& src) : Object(src), m_entityMapping(nullptr) {}
 
    using Base::root;
 
    Document(std::istream& inputStream) : Object(std::make_shared<json>(json::object()), json_pointer{})
    {
        inputStream >> *root();
    }
 
    MNX_REQUIRED_CHILD(Global, global);         
    MNX_REQUIRED_CHILD(MnxMetaData, mnx);       
    MNX_OPTIONAL_CHILD(Array<Layout>, layouts); 
    MNX_REQUIRED_CHILD(Array<Part>, parts);     
    MNX_OPTIONAL_CHILD(Array<Score>, scores);   
 
    [[nodiscard]] static Document create(const std::filesystem::path& inputPath)
    {
        std::ifstream jsonFile;
        jsonFile.exceptions(std::ios::failbit | std::ios::badbit);
        jsonFile.open(inputPath);
        if (!jsonFile.is_open()) {
            throw std::runtime_error("Unable to open JSON file: " + inputPath.string());
        }
        return Document(jsonFile);
    }
 
    template <typename Byte,
              typename = std::enable_if_t<
                         std::is_integral_v<Byte> &&
                         (sizeof(Byte) == 1) &&
                         !std::is_same_v<std::remove_cv_t<Byte>, bool>>>
    [[nodiscard]] static Document create(const Byte* data, std::size_t size)
    {
        if (!data && size != 0) {
            throw std::invalid_argument("JSON buffer pointer is null.");
        }
        auto root = std::make_shared<json>(nlohmann::json::parse(data, data + size));
        return Document(root);
    }
 
    void save(const std::filesystem::path& outputPath, std::optional<int> indentSpaces) const
    {
        std::ofstream file;
        file.exceptions(std::ofstream::failbit | std::ofstream::badbit);
        file.open(outputPath, std::ios::out | std::ios::binary);
        if (!file.is_open()) {
            throw std::runtime_error("Unable to write to JSON file: " + outputPath.string());
        }
        file << root()->dump(indentSpaces.value_or(-1));
        file.close();
    }
 
    void buildEntityMap(EntityMapPolicies policies = {},
                        const std::optional<ErrorHandler>& errorHandler = std::nullopt);
 
    [[nodiscard]] const util::EntityMap& getEntityMap() const
    {
        MNX_ASSERT_IF(!m_entityMapping) {
            throw std::logic_error("Call buildEntityMap before calling getEntityMap.");
        }
        return *m_entityMapping;
    }
 
    [[nodiscard]] bool hasEntityMap() const { return static_cast<bool>(m_entityMapping); }
 
    [[nodiscard]] std::optional<Layout> findFullScoreLayout() const;
};
 
static_assert(std::is_move_constructible<mnx::Document>::value, "Document must be move constructible");
 
} // namespace mnx