/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */

/*
    Rosegarden
    A MIDI and audio sequencer and musical notation editor.
    Copyright 2000-2023 the Rosegarden development team.

    Other copyrights also apply to some parts of this work.  Please
    see the AUTHORS file and individual file headers for details.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef RG_FINGERING_H
#define RG_FINGERING_H

#include <vector>
#include <QString>
#include "base/Event.h"

#include <QCoreApplication>

namespace Rosegarden
{

namespace Guitar
{

class Fingering
{
    Q_DECLARE_TR_FUNCTIONS(Rosegarden::Fingering)

public:
    friend bool operator<(const Fingering&, const Fingering&);

    typedef std::vector<int>::iterator iterator;
    typedef std::vector<int>::const_iterator const_iterator;

    struct Barre {
        unsigned int fret;
        unsigned int start;
        unsigned int end;
    };

    static const unsigned int DEFAULT_NB_STRINGS = 6;

    explicit Fingering(unsigned int nbStrings = DEFAULT_NB_STRINGS);
    explicit Fingering(QString);

    enum { MUTED = -1, OPEN = 0 };

    /**
     * returns the fret number on which the string is pressed, or one of MUTED and OPEN
     *
     */
    int  getStringStatus(int stringNb) const       { return m_strings[stringNb]; }
    void setStringStatus(int stringNb, int status) { m_strings[stringNb] = status; }
    unsigned int getStartFret() const;
    unsigned int getNbStrings() const { return m_strings.size(); }

    bool hasBarre() const;
    Barre getBarre() const;

    int operator[](int i) const { return m_strings[i]; }
    int& operator[](int i) { return m_strings[i]; }

    bool operator==(const Fingering& o) const { return m_strings == o.m_strings; }

    iterator begin() { return m_strings.begin(); }
    iterator end()   { return m_strings.end();   }
    const_iterator begin() const { return m_strings.begin(); }
    const_iterator end()   const { return m_strings.end(); }

    static Fingering parseFingering(const QString&, QString& errorString);
    std::string toString() const;

protected:

    std::vector<int> m_strings;
};

bool operator<(const Fingering&, const Fingering&);

}

}

#endif /*RG_FINGERING_H*/
