Part.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 "Sequence.h"
 
namespace mnx {
 
namespace part {
 
class ArpeggioBase : public ArrayElementObject
{
public:
    ArpeggioBase(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    ArpeggioBase(Base& parent, std::string_view key, const FractionValue& position, const IdPair::Required& span)
        : ArrayElementObject(parent, key)
    {
        create_position(position);
        create_span(span.startId, span.endId);
    }
 
    MNX_REQUIRED_CHILD(
        RhythmicPosition, position,
        (FractionValue, value));            
    MNX_REQUIRED_CHILD(
        IdPair, span,
        (const std::string&, startId),
        (const std::string&, endId));       
};
 
class Arpeggio : public ArpeggioBase
{
public:
    using ArpeggioBase::ArpeggioBase;
 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, arrow, false);                                     
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(MarkingUpDownAuto, direction, MarkingUpDownAuto::Auto);  
};
 
class NonArpeggio : public ArpeggioBase
{
public:
    using ArpeggioBase::ArpeggioBase;
};
 
class Beam : public ArrayElementObject
{
public:
    Beam(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    Beam(Base& parent, std::string_view key)
        : ArrayElementObject(parent, key)
    {
        create_events();
    }
 
    MNX_OPTIONAL_CHILD(Array<Beam>, beams);                 
    MNX_OPTIONAL_PROPERTY(BeamHookDirection, direction);    
    MNX_REQUIRED_CHILD(Array<std::string>, events);         
 
    inline static constexpr std::string_view JsonSchemaTypeName = "beam";     
};
 
class Clef : public Object
{
public:
    struct Required
    {
        ClefSign clefSign{};                    
        int staffPosition{};                    
        OttavaAmountOrZero octaveAdjustment{};  
    };
 
    Clef(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Clef(Base& parent, std::string_view key, ClefSign clefSign, int staffPosition, OttavaAmountOrZero octaveAdjustment = OttavaAmountOrZero::NoTransposition)
        : Object(parent, key)
    {
        set_sign(clefSign);
        set_staffPosition(staffPosition);
        set_or_clear_octave(octaveAdjustment);
    }
 
    operator Required() const { return { sign(), staffPosition(), octave() }; }
 
    static Required make(ClefSign clefSign, int staffPosition, OttavaAmountOrZero octaveAdjustment = OttavaAmountOrZero::NoTransposition)
    { return { clefSign, staffPosition, octaveAdjustment }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, color);      
    MNX_OPTIONAL_PROPERTY(std::string, glyph);      
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(OttavaAmountOrZero, octave, OttavaAmountOrZero::NoTransposition);  
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, showOctave, true); 
    MNX_REQUIRED_PROPERTY(ClefSign, sign);          
    MNX_REQUIRED_PROPERTY(int, staffPosition);      
};
 
class Dynamic : public ArrayElementObject
{
public:
    struct Required
    {
        std::string value;          
        FractionValue position{};   
    };
 
    Dynamic(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    Dynamic(Base& parent, std::string_view key, const std::string& value, const FractionValue& position)
        : ArrayElementObject(parent, key)
    {
        set_value(value);
        create_position(position);
    }
 
    operator Required() const { return { value(), position().fraction() }; }
 
    static Required make(const std::string& value, const FractionValue& position) { return { value, position }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, glyph);                      
    MNX_REQUIRED_CHILD(
        RhythmicPosition, position,
        (const FractionValue&, position)); 
    MNX_OPTIONAL_PROPERTY(int, staff);                              
    MNX_REQUIRED_PROPERTY(std::string, value);                      
    MNX_OPTIONAL_PROPERTY(std::string, voice);                      
};
 
class       Ottava : public ArrayElementObject
{
public:
    struct Required
    {
        OttavaAmount value{};        
        FractionValue position{};    
        std::string endMeasureId;    
        FractionValue endPosition{}; 
    };
 
    Ottava(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    Ottava(Base& parent, std::string_view key, OttavaAmount value, const FractionValue& position, const std::string& endMeasureId, const FractionValue& endPosition)
        : ArrayElementObject(parent, key)
    {
        create_position(position);
        create_end(endMeasureId, endPosition);
        set_value(value);
    }
 
    operator Required() const
    {
        return { value(), position().fraction(), end().measure(), end().position().fraction() };
    }
 
    static Required make(OttavaAmount value, const FractionValue& position, const std::string& endMeasureId, const FractionValue& endPosition)
    { return { value, position, endMeasureId, endPosition }; }
 
    MNX_REQUIRED_CHILD(MeasureRhythmicPosition, end,
        (const std::string&, measureId), (const FractionValue&, position)); 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(Orientation, orient, Orientation::Auto); 
    MNX_REQUIRED_CHILD(RhythmicPosition, position,
        (const FractionValue&, position)); 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staff, 1);              
    MNX_REQUIRED_PROPERTY(OttavaAmount, value);                     
    MNX_OPTIONAL_PROPERTY(std::string, voice);                      
};
 
class KitComponent : public ArrayElementObject
{
public:
    struct Required
    {
        int staffPosition{}; 
    };
 
    KitComponent(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    KitComponent(Base& parent, std::string_view key, int staffPosition)
        : ArrayElementObject(parent, key)
    {
        set_staffPosition(staffPosition);
    }
 
    operator Required() const { return { staffPosition() }; }
 
    static Required make(int staffPosition) { return { staffPosition }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, name);       
    MNX_OPTIONAL_PROPERTY(std::string, sound);      
    MNX_REQUIRED_PROPERTY(int, staffPosition);      
};
 
class PartTransposition : public Object
{
public:
    struct Required
    {
        Interval::Required interval{}; 
    };
 
    PartTransposition(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    PartTransposition(Base& parent, std::string_view key, const Interval::Required& interval)
        : Object(parent, key)
    {
        create_interval(interval.staffDistance, interval.halfSteps);
    }
 
    operator Required() const { return { interval() }; }
 
    static Required make(const Interval::Required& interval) { return { interval }; }
 
    MNX_REQUIRED_CHILD(Interval, interval,
        (int, staffDistance), (int, halfSteps)); 
    MNX_OPTIONAL_PROPERTY(int, keyFifthsFlipAt);    
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, prefersWrittenPitches, false); 
 
    KeySignature::Required calcTransposedKey(const KeySignature::Required& concertKey) const;
};
 
class PositionedClef : public ArrayElementObject
{
public:
    struct Required
    {
        ClefSign clefSign{};                                     
        int staffPosition{};                                     
        OttavaAmountOrZero octaveAdjustment{};                    
    };
 
    PositionedClef(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    PositionedClef(Base& parent, std::string_view key, ClefSign clefSign, int staffPosition, OttavaAmountOrZero octaveAdjustment = OttavaAmountOrZero::NoTransposition)
        : ArrayElementObject(parent, key)
    {
        create_clef(clefSign, staffPosition, octaveAdjustment);
    }
 
    operator Required() const { return { clef().sign(), clef().staffPosition(), clef().octave() }; }
 
    static Required make(ClefSign clefSign, int staffPosition, OttavaAmountOrZero octaveAdjustment = OttavaAmountOrZero::NoTransposition)
    { return { clefSign, staffPosition, octaveAdjustment }; }
 
    MNX_REQUIRED_CHILD(Clef, clef,
        (ClefSign, clefSign), (int, staffPosition), (OttavaAmountOrZero, octaveAdjustment)); 
    MNX_OPTIONAL_CHILD(RhythmicPosition, position,
        (const FractionValue&, position)); 
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staff, 1);  
};
 
class Measure : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    Measure(Base& parent, std::string_view key)
        : ArrayElementObject(parent, key)
    {
        // required children
        create_sequences();
    }
 
    MNX_OPTIONAL_CHILD(Array<Arpeggio>, arpeggios);         
    MNX_OPTIONAL_CHILD(Array<Beam>, beams);                 
    MNX_OPTIONAL_CHILD(Array<PositionedClef>, clefs);       
    MNX_OPTIONAL_CHILD(Array<Dynamic>, dynamics);           
    MNX_OPTIONAL_CHILD(Array<NonArpeggio>, nonArpeggios);   
    MNX_OPTIONAL_CHILD(Array<Ottava>, ottavas);             
    MNX_REQUIRED_CHILD(Array<Sequence>, sequences);         
 
    [[nodiscard]] mnx::global::Measure getGlobalMeasure() const;
 
    [[nodiscard]] std::optional<TimeSignature> calcCurrentTime() const;
 
    inline static constexpr std::string_view JsonSchemaTypeName = "part-measure";     
};
 
} // namespace part
 
class Part : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    Part(Base& parent, std::string_view key)
        : ArrayElementObject(parent, key)
    {
        // required children
        create_measures();
    }
 
    MNX_OPTIONAL_CHILD(Dictionary<part::KitComponent>, kit); 
    MNX_REQUIRED_CHILD(Array<part::Measure>, measures); 
    MNX_OPTIONAL_PROPERTY(std::string, name);           
    MNX_OPTIONAL_PROPERTY(std::string, shortName);      
    MNX_OPTIONAL_PROPERTY(std::string, smuflFont);      
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staves, 1); 
    MNX_OPTIONAL_CHILD(part::PartTransposition, transposition,
        (const Interval::Required&, interval)); 
 
    inline static constexpr std::string_view JsonSchemaTypeName = "measure-global";     
};
 
} // namespace mnx