Global.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 "CommonClasses.h"
 
namespace mnx {
 
namespace global {
 
class Barline : public Object
{
public:
    struct Required
    {
        BarlineType barlineType{}; 
    };
 
    Barline(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Barline(Base& parent, std::string_view key, BarlineType barlineType)
        : Object(parent, key)
    {
        set_type(barlineType);
    }
 
    operator Required() const { return { type() }; }
 
    static Required make(BarlineType barlineType) { return { barlineType }; }
 
    MNX_REQUIRED_PROPERTY(BarlineType, type);  
};
 
class Ending : public Object
{
public:
    struct Required
    {
        int duration{}; 
    };
 
    Ending(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Ending(Base& parent, std::string_view key, int duration)
        : Object(parent, key)
    {
        set_duration(duration);
    }
 
    operator Required() const { return { duration() }; }
 
    static Required make(int duration) { return { duration }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, color);      
    MNX_REQUIRED_PROPERTY(int, duration);           
    MNX_OPTIONAL_CHILD(Array<int>, numbers);        
    MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, open, false);  
};
 
class Fine : public Object
{
public:
    struct Required
    {
        FractionValue position{}; 
    };
 
    Fine(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Fine(Base& parent, std::string_view key, const FractionValue& position)
        : Object(parent, key)
    {
        create_location(position);
    }
 
    operator Required() const { return { location().fraction() }; }
 
    static Required make(const FractionValue& position) { return { position }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, color);                  
    MNX_REQUIRED_CHILD(RhythmicPosition, location,
        (const FractionValue&, position)); 
};
 
class Jump : public Object
{
public:
    struct Required
    {
        JumpType jumpType{};      
        FractionValue position{}; 
    };
 
    Jump(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Jump(Base& parent, std::string_view key, JumpType jumpType, const FractionValue& position)
        : Object(parent, key)
    {
        set_type(jumpType);
        create_location(position);
    }
 
    operator Required() const { return { type(), location().fraction() }; }
 
    static Required make(JumpType jumpType, const FractionValue& position) { return { jumpType, position }; }
 
    MNX_REQUIRED_PROPERTY(JumpType, type);                      
    MNX_REQUIRED_CHILD(RhythmicPosition, location,
        (const FractionValue&, position)); 
};
 
class RepeatEnd : public Object
{
public:
    using Object::Object;
 
    MNX_OPTIONAL_PROPERTY(int, times);               
};
 
class RepeatStart : public Object
{
public:
    using Object::Object;
 
};
 
class Segno : public Object
{
public:
    struct Required
    {
        FractionValue position{}; 
    };
 
    Segno(const std::shared_ptr<json>& root, json_pointer pointer)
        : Object(root, pointer)
    {
    }
 
    Segno(Base& parent, std::string_view key, const FractionValue& position)
        : Object(parent, key)
    {
        create_location(position);
    }
 
    operator Required() const { return { location().fraction() }; }
 
    static Required make(const FractionValue& position) { return { position }; }
 
    MNX_OPTIONAL_PROPERTY(std::string, color);      
    MNX_OPTIONAL_PROPERTY(std::string, glyph);      
    MNX_REQUIRED_CHILD(RhythmicPosition, location,
        (const FractionValue&, position)); 
};
 
class Sound : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    MNX_OPTIONAL_PROPERTY(unsigned, midiNumber);  
    MNX_OPTIONAL_PROPERTY(std::string, name);     
};
 
class Tempo : public ArrayElementObject
{
public:
    struct Required
    {
        int bpm{};                       
        NoteValue::Required noteValue{};   
    };
 
    Tempo(const std::shared_ptr<json>& root, json_pointer pointer)
        : ArrayElementObject(root, pointer)
    {
    }
 
    Tempo(Base& parent, std::string_view key, int bpm, const NoteValue::Required& noteValue)
        : ArrayElementObject(parent, key)
    {
        set_bpm(bpm);
        create_value(noteValue.base, noteValue.dots);
    }
 
    operator Required() const { return { bpm(), value() }; }
 
    static Required make(int bpm, const NoteValue::Required& noteValue) { return { bpm, noteValue }; }
 
    MNX_REQUIRED_PROPERTY(int, bpm);                
    MNX_OPTIONAL_CHILD(RhythmicPosition, location,
        (const FractionValue&, position)); 
    MNX_REQUIRED_CHILD(NoteValue, value,
        (NoteValueBase, base), (unsigned, dots)); 
};
 
class Measure : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    MNX_OPTIONAL_CHILD(Barline, barline,
        (BarlineType, barlineType)); 
    MNX_OPTIONAL_CHILD(Ending, ending,
        (int, duration)); 
    MNX_OPTIONAL_CHILD(Fine, fine,
        (const FractionValue&, position)); 
    MNX_OPTIONAL_CHILD(Jump, jump,
        (JumpType, jumpType), (const FractionValue&, position)); 
    MNX_OPTIONAL_CHILD(KeySignature, key,
        (int, fifths)); 
    MNX_OPTIONAL_PROPERTY(int, number);             
    MNX_OPTIONAL_CHILD(RepeatEnd, repeatEnd);       
    MNX_OPTIONAL_CHILD(RepeatStart, repeatStart);   
    MNX_OPTIONAL_CHILD(Segno, segno,
        (const FractionValue&, position)); 
    MNX_OPTIONAL_CHILD(Array<Tempo>, tempos);       
    MNX_OPTIONAL_CHILD(TimeSignature, time,
        (int, count), (TimeSignatureUnit, unit)); 
 
    [[nodiscard]] BarlineType calcBarlineType() const;
 
    [[nodiscard]] int calcVisibleNumber() const;
 
    [[nodiscard]] std::optional<TimeSignature> calcCurrentTime() const;
 
    [[nodiscard]] std::optional<KeySignature> calcCurrentKey() const;
 
    [[nodiscard]] KeySignature::Required calcCurrentKeyFields() const;
 
    inline static constexpr std::string_view JsonSchemaTypeName = "measure-global";     
};
 
class LyricLineMetadata : public ArrayElementObject
{
public:
    using ArrayElementObject::ArrayElementObject;
 
    MNX_OPTIONAL_PROPERTY(std::string, label);  
    MNX_OPTIONAL_PROPERTY(std::string, lang);   
};
 
class LyricsGlobal : public Object
{
public:
    using Object::Object;
 
    MNX_OPTIONAL_CHILD(Dictionary<LyricLineMetadata>, lineMetadata); 
    MNX_OPTIONAL_CHILD(Array<std::string>, lineOrder);              
};
 
} // namespace global
 
class Global : public Object
{
public:
    using Object::Object;
 
    Global(Base& parent, std::string_view key)
        : Object(parent, key)
    {
        create_measures();
    }
 
    MNX_OPTIONAL_CHILD(global::LyricsGlobal, lyrics);       
    MNX_REQUIRED_CHILD(Array<global::Measure>, measures);   
    MNX_OPTIONAL_CHILD(Dictionary<global::Sound>, sounds);  
};
 
} // namespace mnx