qmlpluginapi.h

Go to the documentation of this file.

//=============================================================================
//  MuseScore
//  Music Composition & Notation
//
//  Copyright (C) 2012 Werner Schweer
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License version 2
//  as published by the Free Software Foundation and appearing in
//  the file LICENCE.GPL
//=============================================================================

#ifndef __QMLPLUGINAPI_H__
#define __QMLPLUGINAPI_H__

#include "config.h"
#include "../qmlplugin.h"
#include "enums.h"
#include "libmscore/mscore.h"
#include "libmscore/utils.h"

namespace Ms {

class Element;
class MScore;

namespace PluginAPI {

class Element;
class FractionWrapper;
class MsProcess;
class Score;

#define DECLARE_API_ENUM(qmlName, cppName) \
      Q_PROPERTY(Ms::PluginAPI::Enum* qmlName READ get_##cppName CONSTANT) \
      static Enum* cppName; \
      static Enum* get_##cppName() { return cppName; }

//---------------------------------------------------------
//   @P scores               array[Ms::Score]  all currently open scores (read only)
//---------------------------------------------------------

class PluginAPI : public Ms::QmlPlugin {
      Q_OBJECT
      Q_PROPERTY(QString menuPath        READ menuPath WRITE setMenuPath)
      Q_PROPERTY(QString filePath        READ filePath)
      Q_PROPERTY(QString version         READ version WRITE setVersion)
      Q_PROPERTY(QString description     READ description WRITE setDescription)
      Q_PROPERTY(QString pluginType      READ pluginType WRITE setPluginType)
      Q_PROPERTY(QString dockArea        READ dockArea WRITE setDockArea)
      Q_PROPERTY(bool requiresScore      READ requiresScore WRITE setRequiresScore)
      Q_PROPERTY(int division            READ division)
      Q_PROPERTY(int mscoreVersion       READ mscoreVersion       CONSTANT)
      Q_PROPERTY(int mscoreMajorVersion  READ mscoreMajorVersion  CONSTANT)
      Q_PROPERTY(int mscoreMinorVersion  READ mscoreMinorVersion  CONSTANT)
      Q_PROPERTY(int mscoreUpdateVersion READ mscoreUpdateVersion CONSTANT)
      Q_PROPERTY(qreal mscoreDPI         READ mscoreDPI)
      Q_PROPERTY(Ms::PluginAPI::Score* curScore     READ curScore)
      Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Score> scores READ scores)

      // Should be initialized in qmlpluginapi.cpp
      DECLARE_API_ENUM( Element,          elementTypeEnum         )
      DECLARE_API_ENUM( Accidental,       accidentalTypeEnum      )
      DECLARE_API_ENUM( Beam,             beamModeEnum            )
      DECLARE_API_ENUM( Placement,        placementEnum           )
      DECLARE_API_ENUM( Glissando,        glissandoTypeEnum       ) // was probably absent in 2.X
      DECLARE_API_ENUM( LayoutBreak,      layoutBreakTypeEnum     )
      DECLARE_API_ENUM( Lyrics,           lyricsSyllabicEnum      )
      DECLARE_API_ENUM( Direction,        directionEnum           )
      DECLARE_API_ENUM( DirectionH,       directionHEnum          )
      DECLARE_API_ENUM( OrnamentStyle,    ornamentStyleEnum       )
      DECLARE_API_ENUM( GlissandoStyle,   glissandoStyleEnum      )
      DECLARE_API_ENUM( Tid,              tidEnum                 )
      DECLARE_API_ENUM( Align,            alignEnum               )
      DECLARE_API_ENUM( NoteType,         noteTypeEnum            )
      DECLARE_API_ENUM( PlayEventType,    playEventTypeEnum       )
      DECLARE_API_ENUM( NoteHeadType,     noteHeadTypeEnum        )
      DECLARE_API_ENUM( NoteHeadGroup,    noteHeadGroupEnum       )
      DECLARE_API_ENUM( NoteValueType,    noteValueTypeEnum       )
      DECLARE_API_ENUM( Segment,          segmentTypeEnum         )
      DECLARE_API_ENUM( Spanner,          spannerAnchorEnum       ) // probably unavailable in 2.X

      QFile logFile;

      static void initEnums();

   signals:
      void run();

      void scoreStateChanged(const QMap<QString, QVariant>& state);

   public:
      PluginAPI(QQuickItem* parent = 0);

      static void registerQmlTypes();

      void runPlugin() override            { emit run();       }
      void endCmd(const QMap<QString, QVariant>& stateInfo) override { emit scoreStateChanged(stateInfo); }

      Score* curScore() const;
      QQmlListProperty<Score> scores();

      Q_INVOKABLE Ms::PluginAPI::Score* newScore(const QString& name, const QString& part, int measures);
      Q_INVOKABLE Ms::PluginAPI::Element* newElement(int);
      Q_INVOKABLE void removeElement(Ms::PluginAPI::Element* wrapped);
      Q_INVOKABLE void cmd(const QString&);
      Q_INVOKABLE Ms::PluginAPI::MsProcess* newQProcess();
      Q_INVOKABLE bool writeScore(Ms::PluginAPI::Score*, const QString& name, const QString& ext);
      Q_INVOKABLE Ms::PluginAPI::Score* readScore(const QString& name, bool noninteractive = false);
      Q_INVOKABLE void closeScore(Ms::PluginAPI::Score*);

      Q_INVOKABLE void log(const QString&);
      Q_INVOKABLE void logn(const QString&);
      Q_INVOKABLE void log2(const QString&, const QString&);
      Q_INVOKABLE void openLog(const QString&);
      Q_INVOKABLE void closeLog();

      Q_INVOKABLE Ms::PluginAPI::FractionWrapper* fraction(int numerator, int denominator) const;
      };

#undef DECLARE_API_ENUM
} // namespace PluginAPI
} // namespace Ms
#endif