Layout.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 "Enumerations.h"
#include "BaseTypes.h"
#include "ContentArray.h"
 
namespace mnx {
 
namespace layout {
class Group;
class Staff;
 
class LayoutContentObject : public ContentObject<LayoutContentObject>
{
public:
    using ContentObject::ContentObject;
    std::string_view defaultType() const override { return ""; }
};
 
class LayoutContent : public ContentArray<LayoutContentObject>
{
public:
    using ContentArray<LayoutContentObject>::ContentArray;
 
    Group appendGroup();
    Staff appendStaff();
};
 
class StaffSource : public ArrayElementObject
{
public:
    struct Required
    {
        std::string partId; 
    };
 
    StaffSource(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
    
    StaffSource(Base& parent, std::string_view key, const std::string& partId)
        : ArrayElementObject(parent, key)
    {
        set_part(partId);
    }
 
    operator Required() const { return { part() }; }
 
    static Required make(const std::string& partId) { return { partId }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, label);          
    MNX_OPTIONAL_PROPERTY(LabelRef, labelref);          
    MNX_REQUIRED_PROPERTY(std::string, part);           
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staff, 1);  
    MNX_OPTIONAL_PROPERTY(StemDirection, stem);         
    MNX_OPTIONAL_PROPERTY(std::string, voice);          
};
 
class Staff : public LayoutContentObject
{
public:
    using LayoutContentObject::LayoutContentObject;
 
    Staff(Base& parent, std::string_view key)
        : LayoutContentObject(parent, key)
    {
        // required children
        create_sources();
    }
 
    MNX_OPTIONAL_PROPERTY(std::string, label);                  
    MNX_OPTIONAL_PROPERTY(LabelRef, labelref);                  
    MNX_REQUIRED_CHILD(Array<StaffSource>, sources);            
    MNX_OPTIONAL_PROPERTY(LayoutSymbol, symbol);                
 
    inline static constexpr std::string_view ContentTypeValue = "staff"; 
};
 
class Group : public LayoutContentObject
{
public:
    using LayoutContentObject::LayoutContentObject;
 
    Group(Base& parent, std::string_view key)
        : LayoutContentObject(parent, key)
    {
        // required children
        create_content();
    }
 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(StaffGroupBarlineStyle, barlineStyle, StaffGroupBarlineStyle::Instrument); 
    MNX_REQUIRED_CHILD(LayoutContent, content);      
    MNX_OPTIONAL_PROPERTY(std::string, label);      
    MNX_OPTIONAL_PROPERTY(LayoutSymbol, symbol);    
 
    [[nodiscard]] bool calcIsPartGroup() const;
 
    [[nodiscard]] StaffGroupBarlineOverride calcBarlineOverride() const;
 
    inline static constexpr std::string_view ContentTypeValue = "group"; 
};
 
inline Group LayoutContent::appendGroup()
{ return appendWithType<Group>(); }
 
inline Staff LayoutContent::appendStaff()
{ return appendWithType<Staff>(); }
 
} // namespace layout
 
class Layout : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    Layout(Base& parent, std::string_view key)
        : ArrayElementObject(parent, key)
    {
        // required children
        create_content();
    }
 
    MNX_REQUIRED_CHILD(layout::LayoutContent, content);      
 
    inline static constexpr std::string_view JsonSchemaTypeName = "system-layout";     
};
 
} // namespace mnx