MuseScore/src/plugins/api/part.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 __PLUGIN_API_PART_H__
#define __PLUGIN_API_PART_H__

#include "scoreelement.h"
#include "libmscore/part.h"

namespace Ms {
namespace PluginAPI {
class Instrument;
class Part;

//---------------------------------------------------------
//   InstrumentListProperty
///   \cond PLUGIN_API \private \endcond
//---------------------------------------------------------

class InstrumentListProperty : public QQmlListProperty<Instrument>
{
public:
    InstrumentListProperty(Part* p);

    static int count(QQmlListProperty<Instrument>* l);
    static Instrument* at(QQmlListProperty<Instrument>* l, int i);
};

//---------------------------------------------------------
//   Part
//---------------------------------------------------------

class Part : public Ms::PluginAPI::ScoreElement
{
    Q_OBJECT
    Q_PROPERTY(int startTrack READ startTrack)
    Q_PROPERTY(int endTrack READ endTrack)
    /**
     * The string identifier
     * ([MusicXML Sound ID](https://www.musicxml.com/for-developers/standard-sounds/))
     * for the first instrument in this part.
     * \see \ref Ms::PluginAPI::Instrument::instrumentId "Instrument.instrumentId"
     * \since MuseScore 3.2
     */
    Q_PROPERTY(QString instrumentId READ instrumentId)
    /// The number of Chord Symbols. \since MuseScore 3.2.1
    Q_PROPERTY(int harmonyCount READ harmonyCount)
    /// Whether it is a percussion staff. \since MuseScore 3.2.1
    Q_PROPERTY(bool hasDrumStaff READ hasDrumStaff)
    /// Whether it is a 'normal' staff with notes. \since MuseScore 3.2.1
    Q_PROPERTY(bool hasPitchedStaff READ hasPitchedStaff)
    /// Whether it is a tablature staff. \since MuseScore 3.2.1
    Q_PROPERTY(bool hasTabStaff READ hasTabStaff)
    /// The number of lyrics syllables. \since MuseScore 3.2.1
    Q_PROPERTY(int lyricCount READ lyricCount)
    /// One of 16 music channels that can be assigned an instrument. \since MuseScore 3.2.1
    Q_PROPERTY(int midiChannel READ midiChannel)
    /// One of the 128 different instruments in General MIDI. \since MuseScore 3.2.1
    Q_PROPERTY(int midiProgram READ midiProgram)
    /// The long name for the current instrument.
    /// Note that this property was writeable in MuseScore v2.x
    /// \since MuseScore 3.2.1
    Q_PROPERTY(QString longName READ longName)
    /// The short name for the current instrument.
    /// Note that this property was writeable in MuseScore v2.x
    /// \since MuseScore 3.2.1
    Q_PROPERTY(QString shortName READ shortName)
    /// The name of the current part of music.
    /// It is shown in Mixer.
    ///
    /// Note that this property was writeable in MuseScore v2.x
    /// \since MuseScore 3.2.1
    Q_PROPERTY(QString partName READ partName)
    /// Whether part is shown or hidden.
    /// This property is writeable since MuseScore 3.6 (and was writable in MuseScore 2.x)
    /// \since MuseScore 3.2.1
    Q_PROPERTY(bool show READ show WRITE setShow)

    /**
     * List of instruments in this part.
     * \since MuseScore 3.5
     */
    Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Instrument> instruments READ instruments);

public:
    /// \cond MS_INTERNAL
    Part(Ms::Part* p = nullptr, Ownership o = Ownership::SCORE)
        : ScoreElement(p, o) {}

    Ms::Part* part() { return toPart(e); }
    const Ms::Part* part() const { return toPart(e); }

    int startTrack() const { return part()->startTrack(); }
    int endTrack()   const { return part()->endTrack(); }
    QString instrumentId() const { return part()->instrument()->id(); }
    int harmonyCount() const { return part()->harmonyCount(); }
    bool hasPitchedStaff() const { return part()->hasPitchedStaff(); }
    bool hasTabStaff() const { return part()->hasTabStaff(); }
    bool hasDrumStaff() const { return part()->hasDrumStaff(); }
    int lyricCount() const { return part()->lyricCount(); }
    int midiChannel() const { return part()->midiChannel(); }
    int midiProgram() const { return part()->midiProgram(); }
    QString longName() const { return part()->longName(); }
    QString shortName() const { return part()->shortName(); }
    QString partName() const { return part()->partName(); }
    bool show() const { return part()->show(); }
    void setShow(bool val) { set(Pid::VISIBLE, val); }

    InstrumentListProperty instruments();
    /// \endcond

    /**
     * Finds an instrument that is active in this part at the given \p tick.
     * \since MuseScore 3.5
     */
    Q_INVOKABLE Ms::PluginAPI::Instrument* instrumentAtTick(int tick);
};
} // namespace PluginAPI
} // namespace Ms
#endif