Chord.h

Go to the documentation of this file.

// Copyright (c) XJ Music Inc. (https://xjmusic.com) All Rights Reserved.
 
#ifndef XJMUSIC_MUSIC_CHORD_H
#define XJMUSIC_MUSIC_CHORD_H
 
#include <iostream>
#include <vector>
#include <string>
 
#include "PitchClass.h"
#include "SlashRoot.h"
#include "Accidental.h"
#include "Root.h"
 
namespace XJ {
 
  class ChordSynonym {
  public:
    std::string match;
    bool caseSensitive;
 
    explicit ChordSynonym(const std::string &match, bool caseSensitive = false);
 
    bool operator==(const ChordSynonym &other) const;
 
    [[nodiscard]] bool matches(const std::string &input) const;
  };
 
  class ChordForm {
  public:
    std::string description;
    std::vector<ChordSynonym> synonyms{};
 
    ChordForm(const std::string &description, const std::vector<ChordSynonym> &synonyms);
 
    [[nodiscard]] bool matches(const std::string &input) const;
 
    bool operator==(const ChordForm &other) const;
 
    std::size_t hashCode();
 
  };
 
  class Chord {
  private:
    static std::vector<ChordForm> forms;
 
  public:
    std::string description;
 
    PitchClass root; // Root Pitch Class
 
    SlashRoot slashRoot; // Slash Root Pitch Class
 
    Accidental accidental; // the (flat/sharp) adjustment symbol, which will be used to express this chord
 
    bool operator<(const Chord &other) const;
 
    bool operator==(const Chord &other) const;
 
    explicit Chord(const std::string &input);
 
    static std::string normalize(const std::string &input);
 
    std::string toString() const;
 
    [[nodiscard]] int delta(const Chord &target) const;
 
    [[nodiscard]] std::string getName() const;
 
    PitchClass slashRootPitchClass();
 
    static Chord of(const std::string &name);
 
    [[nodiscard]] bool isNoChord() const;
 
    bool isAcceptable(const Chord &other) const;
 
    [[nodiscard]] bool has_value() const;
  };
 
}// namespace XJ
 
#endif// XJMUSIC_MUSIC_CHORD_H