Notation.h

#ifndef MCC_NOTATION_NOTATION_H
#define MCC_NOTATION_NOTATION_H
 
#include <stddef.h>
#include <stdint.h>
 
#include <MCC/Interval/Interval.h>
#include <MCC/Pitch/NoteName.h>
#include <MCC/Pitch/Pitch.h>
 
#if __has_include(<MCC/Scale/Scales.h>)
    #include <MCC/Scale/Scales.h>
#endif
#if __has_include(<MCC/Chord/Chords.h>)
    #include <MCC/Chord/Chords.h>
#endif
#if __has_include(<MCC/Key/Key.h>)
    #include <MCC/Key/Key.h>
#endif
 
namespace MCC {

enum class NotationSymbols : uint8_t {
    Ascii,      
    Unicode     
};

struct NotationOptions {
    NotationSymbols symbols = NotationSymbols::Ascii;
    bool explicitNatural = false;
};

namespace Notation {

    using CodePointSink = void (*)(uint32_t codePoint, void* context);

    template <typename CharT>
    size_t Format(CharT* destination, size_t capacity, NoteName noteName,
                  NotationOptions options = NotationOptions()) noexcept;

    template <typename CharT>
    size_t Format(CharT* destination, size_t capacity, Pitch pitch,
                  NotationOptions options = NotationOptions()) noexcept;

    template <typename CharT>
    size_t Format(CharT* destination, size_t capacity, Interval interval,
                  NotationOptions options = NotationOptions()) noexcept;

    size_t Format(CodePointSink sink, void* context, NoteName noteName,
                  NotationOptions options = NotationOptions()) noexcept;

    size_t Format(CodePointSink sink, void* context, Pitch pitch,
                  NotationOptions options = NotationOptions()) noexcept;

    size_t Format(CodePointSink sink, void* context, Interval interval,
                  NotationOptions options = NotationOptions()) noexcept;

    template <typename CharT>
    NoteName ParseNoteName(const CharT* text) noexcept;

    template <typename CharT>
    Pitch ParsePitch(const CharT* text) noexcept;

    template <typename CharT>
    Interval ParseInterval(const CharT* text) noexcept;
 
#if __has_include(<MCC/Scale/Scales.h>)
    template <typename CharT>
    size_t Format(CharT* destination, size_t capacity, NoteName root, Scales::Id id,
                  NotationOptions options = NotationOptions()) noexcept;

    size_t Format(CodePointSink sink, void* context, NoteName root, Scales::Id id,
                  NotationOptions options = NotationOptions()) noexcept;
#endif
 
#if __has_include(<MCC/Chord/Chords.h>)
    template <typename CharT>
    size_t Format(CharT* destination, size_t capacity, NoteName root, Chords::Id id,
                  NotationOptions options = NotationOptions()) noexcept;

    size_t Format(CodePointSink sink, void* context, NoteName root, Chords::Id id,
                  NotationOptions options = NotationOptions()) noexcept;
#endif
 
#if __has_include(<MCC/Key/Key.h>)
    template <typename CharT>
    size_t Format(CharT* destination, size_t capacity, Key key,
                  NotationOptions options = NotationOptions()) noexcept;

    size_t Format(CodePointSink sink, void* context, Key key,
                  NotationOptions options = NotationOptions()) noexcept;
#endif
 
} // namespace Notation
 
} // namespace MCC
 
#endif // MCC_NOTATION_NOTATION_H