MuseScore/src/engraving/libmscore/clef.h

/*
 * SPDX-License-Identifier: GPL-3.0-only
 * MuseScore-CLA-applies
 *
 * MuseScore
 * Music Composition & Notation
 *
 * Copyright (C) 2021 MuseScore BVBA and others
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef __CLEF_H__
#define __CLEF_H__

/**
 \file
 Definition of classes Clef
*/

#include "engravingitem.h"
#include "mscore.h"

namespace mu::engraving {
class Factory;
}

namespace Ms {
class XmlWriter;
class MuseScoreView;
class Segment;

static const int NO_CLEF = -1000;

//---------------------------------------------------------
//   ClefType
//---------------------------------------------------------

enum class ClefType : signed char {
    INVALID = -1,
    G = 0,
    G15_MB,
    G8_VB,
    G8_VA,
    G15_MA,
    G8_VB_O,
    G8_VB_P,
    G_1,
    C1,
    C2,
    C3,
    C4,
    C5,
    C_19C,
    C1_F18C,
    C3_F18C,
    C4_F18C,
    C3_F20C,
    C1_F20C,
    C4_F20C,
    F,
    F15_MB,
    F8_VB,
    F_8VA,
    F_15MA,
    F_B,
    F_C,
    F_F18C,
    F_19C,
    PERC,
    PERC2,
    TAB,
    TAB4,
    TAB_SERIF,
    TAB4_SERIF,
    MAX
};

//---------------------------------------------------------
//   ClefTypeList
//---------------------------------------------------------

struct ClefTypeList {
    ClefType _concertClef = ClefType::G;
    ClefType _transposingClef = ClefType::G;

    ClefTypeList() {}
    ClefTypeList(ClefType a, ClefType b)
        : _concertClef(a), _transposingClef(b) {}
    ClefTypeList(ClefType a)
        : _concertClef(a), _transposingClef(a) {}
    bool operator==(const ClefTypeList& t) const;
    bool operator!=(const ClefTypeList& t) const;
};

//---------------------------------------------------------
//   ClefInfo
///   Info about a clef.
//---------------------------------------------------------

class ClefInfo
{
public:
    static const ClefInfo clefTable[];

    const char* _tag;          ///< comprehensive name for instruments.xml
    const char* _sign;         ///< Name for musicXml.
    int _line;                 ///< Line for musicXml and for positioning on the staff
    int _octChng;              ///< Octave change for musicXml.
    int _pitchOffset;          ///< Pitch offset for line 0.
    signed char _lines[14];
    SymId _symId;
    const char* _name;
    StaffGroup _staffGroup;

public:
    static const char* tag(ClefType t) { return clefTable[int(t)]._tag; }
    static const char* sign(ClefType t) { return clefTable[int(t)]._sign; }
    static int line(ClefType t) { return clefTable[int(t)]._line; }
    static int octChng(ClefType t) { return clefTable[int(t)]._octChng; }
    static int pitchOffset(ClefType t) { return clefTable[int(t)]._pitchOffset; }
    static SymId symId(ClefType t) { return clefTable[int(t)]._symId; }
    static const signed char* lines(ClefType t) { return clefTable[int(t)]._lines; }
    static const char* name(ClefType t) { return clefTable[int(t)]._name; }
    static StaffGroup staffGroup(ClefType t) { return clefTable[int(t)]._staffGroup; }
    static ClefType tag2type(const QString&);
};

//---------------------------------------------------------
//   @@ Clef
///    Graphic representation of a clef.
//
//   @P showCourtesy  bool    show/hide courtesy clef when applicable
//   @P isSmall       bool    small, mid-staff clef (read only, set by layout)
//---------------------------------------------------------

class Clef final : public EngravingItem
{
    SymId symId;
    bool _showCourtesy = true;
    bool m_isSmall = false;
    bool _forInstrumentChange = false;

    ClefTypeList _clefTypes { ClefType::INVALID };

    friend class mu::engraving::Factory;
    Clef(Segment* parent);

public:

    Clef* clone() const override { return new Clef(*this); }
    qreal mag() const override;

    Segment* segment() const { return (Segment*)parent(); }
    Measure* measure() const { return (Measure*)parent()->parent(); }

    bool acceptDrop(EditData&) const override;
    EngravingItem* drop(EditData&) override;
    void layout() override;
    void draw(mu::draw::Painter*) const override;
    void read(XmlReader&) override;
    void write(XmlWriter&) const override;

    bool isEditable() const override { return false; }

    bool isSmall() const { return m_isSmall; }
    void setSmall(bool val);

    bool showCourtesy() const { return _showCourtesy; }
    void setShowCourtesy(bool v) { _showCourtesy = v; }
    void undoSetShowCourtesy(bool v);
    Clef* otherClef();

    static ClefType clefType(const QString& s);
    const char* clefTypeName();

    ClefType clefType() const;
    void setClefType(ClefType i);
    void setClefType(const QString& s);

    void setForInstrumentChange(bool forInstrumentChange) { _forInstrumentChange = forInstrumentChange; }
    bool forInstrumentChange() const { return _forInstrumentChange; }

    ClefTypeList clefTypeList() const { return _clefTypes; }
    ClefType concertClef() const { return _clefTypes._concertClef; }
    ClefType transposingClef() const { return _clefTypes._transposingClef; }
    void setConcertClef(ClefType val);
    void setTransposingClef(ClefType val);
    void setClefType(const ClefTypeList& ctl) { _clefTypes = ctl; }
    void spatiumChanged(qreal oldValue, qreal newValue) override;

    mu::engraving::PropertyValue getProperty(Pid propertyId) const override;
    bool setProperty(Pid propertyId, const mu::engraving::PropertyValue&) override;
    mu::engraving::PropertyValue propertyDefault(Pid id) const override;

    EngravingItem* nextSegmentElement() override;
    EngravingItem* prevSegmentElement() override;
    QString accessibleInfo() const override;
    void clear();
};
}     // namespace Ms
#endif