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 Beam : public ArrayElementObject
{
public:
    Beam(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    Beam(Base& parent, const 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);         
};
 
class Clef : public Object
{
public:
    Clef(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Clef(Base& parent, const std::string_view& key, ClefSign clefSign, int staffPosition, std::optional<OttavaAmountOrZero> octaveAdjustment = std::nullopt)
        : Object(parent, key)
    {
        set_sign(clefSign);
        set_staffPosition(staffPosition);
        if (octaveAdjustment.has_value()) {
            set_octave(octaveAdjustment.value());
        }
    }
 
    MNX_OPTIONAL_NAMED_PROPERTY(std::string, styleClass, "class"); 
    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 ContentObject
{
public:
    Dynamic(const std::shared_ptr<json>& root, json_pointer pointer)
        : ContentObject(root, pointer)
    {
    }
 
    Dynamic(Base& parent, const std::string_view& key, const std::string& value, const Fraction::Initializer& position)
        : ContentObject(parent, key)
    {
        set_value(value);
        create_position(position);
    }
 
    MNX_OPTIONAL_PROPERTY(std::string, glyph);                      
    MNX_REQUIRED_CHILD(RhythmicPosition, position);                 
    MNX_OPTIONAL_PROPERTY(int, staff);                              
    MNX_REQUIRED_PROPERTY(std::string, value);                      
    MNX_OPTIONAL_PROPERTY(std::string, voice);                      
};
 
class Ottava : public ArrayElementObject
{
public:
    Ottava(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    Ottava(Base& parent, const std::string_view& key, OttavaAmount value, const Fraction::Initializer& position, int endMeasureId, const Fraction::Initializer& endPosition)
        : ArrayElementObject(parent, key)
    {
        create_position(position);
        create_end(endMeasureId, endPosition);
        set_value(value);
    }
 
    MNX_REQUIRED_CHILD(MeasureRhythmicPosition, end);               
    MNX_REQUIRED_CHILD(RhythmicPosition, position);                 
    MNX_OPTIONAL_PROPERTY(int, staff);                              
    MNX_REQUIRED_PROPERTY(OttavaAmount, value);                     
    MNX_OPTIONAL_PROPERTY(std::string, voice);                      
};
 
class KitComponent : public ArrayElementObject
{
public:
    KitComponent(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    KitComponent(Base& parent, const std::string_view& key, int staffPosition)
        : ArrayElementObject(parent, key)
    {
        set_staffPosition(staffPosition);
    }
 
    MNX_OPTIONAL_PROPERTY(std::string, name);       
    MNX_OPTIONAL_PROPERTY(std::string, sound);      
    MNX_REQUIRED_PROPERTY(int, staffPosition);      
};
 
class PartTransposition : public Object
{
public:
    PartTransposition(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    PartTransposition(Base& parent, const std::string_view& key, int diatonic, int chromatic)
        : Object(parent, key)
    {
        create_interval(diatonic, chromatic);
    }
 
    MNX_REQUIRED_CHILD(Interval, interval);         
    MNX_OPTIONAL_PROPERTY(int, keyFifthsFlipAt);    
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, prefersWrittenPitches, false); 
};
 
class PositionedClef : public ArrayElementObject
{
public:
    PositionedClef(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    PositionedClef(Base& parent, const std::string_view& key, ClefSign clefSign, int staffPosition, std::optional<OttavaAmountOrZero> octaveAdjustment = std::nullopt)
        : ArrayElementObject(parent, key)
    {
        create_clef(clefSign, staffPosition, octaveAdjustment);
    }
 
    MNX_REQUIRED_CHILD(Clef, clef);                     
    MNX_OPTIONAL_CHILD(RhythmicPosition, position);     
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staff, 1);  
};
 
class Measure : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    Measure(Base& parent, const std::string_view& key)
        : ArrayElementObject(parent, key)
    {
        // required children
        create_sequences();
    }
 
    MNX_OPTIONAL_CHILD(Array<Beam>, beams);             
    MNX_OPTIONAL_CHILD(Array<PositionedClef>, clefs);   
    MNX_OPTIONAL_CHILD(Array<Dynamic>, dynamics);       
    MNX_OPTIONAL_CHILD(Array<Ottava>, ottavas);         
    MNX_REQUIRED_CHILD(Array<Sequence>, sequences);     
};
 
} // namespace part
 
class Part : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    MNX_OPTIONAL_CHILD(Dictionary<part::KitComponent>, kit); 
    MNX_OPTIONAL_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); 
};
 
} // namespace mnx