SlashRoot.h

Go to the documentation of this file.

// Copyright (c) XJ Music Inc. (https://xjmusic.com) All Rights Reserved.
 
#ifndef XJMUSIC_MUSIC_SLASH_ROOT_H
#define XJMUSIC_MUSIC_SLASH_ROOT_H
 
#include <optional>
#include <regex>
#include <string>
 
#include "PitchClass.h"
 
namespace XJ {
 
  class SlashRoot {
  private:
    static std::regex rgxSlashPost;
    static std::regex rgxSlashNote;
    static std::regex rgxSlashNoteModified;
    static std::regex rgxSlashPre;
 
  public:
    std::optional<PitchClass> pitchClass;
    std::string pre;
    std::string post;
 
    explicit SlashRoot(const std::string& name);
 
    static SlashRoot of(const std::string &name);
 
    bool operator==(const SlashRoot &other) const;
 
    static SlashRoot none();
 
    [[nodiscard]] PitchClass orDefault(PitchClass dpc) const;
 
    static std::string computePre(const std::string &description);
 
    static bool has_value(const std::string &name);
 
    [[nodiscard]] bool has_value() const;
 
    [[nodiscard]] std::string display(Accidental withOptional) const;
  };
 
}// namespace XJ
 
#endif// XJMUSIC_MUSIC_SLASH_ROOT_H