Dynamics.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 "BaseTypes.h"
#include "ContentArray.h"
 
namespace mnx {
namespace part {
 
class DynamicGroupArray;
class DynamicAccent;
class DynamicGradual;
class DynamicImmediate;
class DynamicRelative;
 
class DynamicGroupBase : public ContentObject<DynamicGroupBase>
{
public:
    std::string_view defaultType() const override { return ""; }
    DynamicGroupBase(const std::shared_ptr<json>& root, json_pointer pointer)
        : ContentObject(root, pointer)
    {
    }
 
    DynamicGroupBase(Base& parent, std::string_view key, const FractionValue& position)
        : ContentObject(parent, key)
    {
        create_position(position);
    }
 
    MNX_OPTIONAL_CHILD(Array<std::string>, glyphs);                 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(MultiStaffOrientation, orient, MultiStaffOrientation::Auto); 
    MNX_REQUIRED_CHILD(
        RhythmicPosition, position,
        (const FractionValue&, position));                          
    MNX_OPTIONAL_PROPERTY(std::string, prefix);                     
    MNX_OPTIONAL_PROPERTY(int, staff);                              
    MNX_OPTIONAL_PROPERTY(std::string, suffix);                     
    MNX_OPTIONAL_PROPERTY(DynamicValue, value);                     
    MNX_OPTIONAL_PROPERTY(std::string, visuallyContinues);          
    MNX_OPTIONAL_PROPERTY(std::string, voice);                      
 
    virtual bool calcHasImmediateText() const
    {
        return value() || !prefix_or({}).empty() || !suffix_or({}).empty()
            || (glyphs() && !glyphs().value().empty());
    }
};
 
class DynamicAccent : public DynamicGroupBase
{
public:
    struct Required
    {
        DynamicValue value{};      
        FractionValue position{};  
    };
 
    DynamicAccent(const std::shared_ptr<json>& root, json_pointer pointer)
        : DynamicGroupBase(root, pointer)
    {}
 
    DynamicAccent(Base& parent, std::string_view key, DynamicValue value, const FractionValue& position)
        : DynamicGroupBase(parent, key, position)
    {
        set_value(value);
    }
 
    operator Required() const { return { value().value(), position().fraction() }; }
 
    static Required make(DynamicValue value, const FractionValue& position) { return { value, position }; }
 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(DynamicPrefix, accentPrefix, DynamicPrefix::s); 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(DynamicSuffix, accentSuffix, DynamicSuffix::z); 
    MNX_OPTIONAL_PROPERTY(DynamicValue, residualValue);             
 
    bool calcHasImmediateText() const override
    {
        return DynamicGroupBase::calcHasImmediateText()
            || accentPrefix() != DynamicPrefix::None
            || accentSuffix() != DynamicSuffix::None
            || residualValue();
    }
 
    inline static constexpr std::string_view ContentTypeValue = "accent";    
};
 
class DynamicGradual : public DynamicGroupBase
{
public:
    struct Required
    {
        DynamicWedgeType wedgeType{}; 
        FractionValue position{};     
        std::string endMeasureId;     
        FractionValue endPosition{};  
    };
 
    DynamicGradual(const std::shared_ptr<json>& root, json_pointer pointer)
        : DynamicGroupBase(root, pointer)
    {
    }
 
    DynamicGradual(Base& parent, std::string_view key, DynamicWedgeType wedgeType, const FractionValue& position,
        const MeasureRhythmicPosition::Required& endPosition)
        : DynamicGroupBase(parent, key, position)
    {
        create_end(endPosition.measureId, endPosition.position);
        set_wedgeType(wedgeType);
    }
 
    operator Required() const
    {
        return { wedgeType(), position().fraction(), end().measure(), end().position().fraction() };
    }
 
    static Required make(DynamicWedgeType wedgeType, const FractionValue& position, const MeasureRhythmicPosition::Required& endPosition)
    { return { wedgeType, position, endPosition.measureId, endPosition.position }; }
 
    MNX_REQUIRED_CHILD(MeasureRhythmicPosition, end,
        (const std::string&, measureId), (const FractionValue&, position));     
    MNX_OPTIONAL_PROPERTY(int, staffEnd);                                       
    MNX_REQUIRED_PROPERTY(DynamicWedgeType, wedgeType);                         
 
    inline static constexpr std::string_view ContentTypeValue = "gradual";      
};
 
class DynamicImmediate : public DynamicGroupBase
{
public:
    struct Required
    {
        DynamicValue value{};      
        FractionValue position{};  
    };
 
    DynamicImmediate(const std::shared_ptr<json>& root, json_pointer pointer)
        : DynamicGroupBase(root, pointer)
    {}
 
    DynamicImmediate(Base& parent, std::string_view key, DynamicValue value, const FractionValue& position)
        : DynamicGroupBase(parent, key, position)
    {
        set_value(value);
    }
 
    operator Required() const { return { value().value(), position().fraction() }; }
 
    static Required make(DynamicValue value, const FractionValue& position) { return { value, position }; }
 
    inline static constexpr std::string_view ContentTypeValue = "immediate";    
};
 
class DynamicRelative : public DynamicGroupBase
{
public:
    struct Required
    {
        DynamicRelativeValue relativeValue{}; 
        FractionValue position{};             
    };
 
    DynamicRelative(const std::shared_ptr<json>& root, json_pointer pointer)
        : DynamicGroupBase(root, pointer)
    {}
 
    DynamicRelative(Base& parent, std::string_view key, DynamicRelativeValue relativeValue, const FractionValue& position)
        : DynamicGroupBase(parent, key, position)
    {
        set_relativeValue(relativeValue);
    }
 
    operator Required() const { return { relativeValue(), position().fraction() }; }
 
    static Required make(DynamicRelativeValue relativeValue, const FractionValue& position) { return { relativeValue, position }; }
 
    MNX_REQUIRED_PROPERTY(DynamicRelativeValue, relativeValue);     
 
    inline static constexpr std::string_view ContentTypeValue = "relative";    
};
 
class DynamicGroupArray : public ContentArray<part::DynamicGroupBase>
{
public:
    using ContentArray<part::DynamicGroupBase>::ContentArray;
 
    part::DynamicAccent appendAccent(DynamicValue value, const FractionValue& position)
    { return appendWithType<part::DynamicAccent>(value, position); }
 
    part::DynamicGradual appendGradual(DynamicWedgeType wedgeType, const FractionValue& position,
        const MeasureRhythmicPosition::Required& endPosition)
    { return appendWithType<part::DynamicGradual>(wedgeType, position, endPosition); }
 
    part::DynamicImmediate appendImmediate(DynamicValue value, const FractionValue& position)
    { return appendWithType<part::DynamicImmediate>(value, position); }
 
    part::DynamicRelative appendRelative(DynamicRelativeValue relativeValue, const FractionValue& position)
    { return appendWithType<part::DynamicRelative>(relativeValue, position); }
};
 
} // namespace part
} // namespace mnx