Plugin API: partially restore readScore, closeScore and writeScore

Author: dmitrio95

src/engraving/api/v1/qmlpluginapi.cpp

@@ -26,10 +26,14 @@
 #include <QJSValueIterator>
 
 #include "engraving/compat/scoreaccess.h"
+#include "engraving/dom/masterscore.h"
 #include "engraving/dom/factory.h"
 #include "engraving/dom/interval.h"
 #include "engraving/types/types.h"
 
+#include "notation/inotation.h"
+#include "project/inotationwriter.h"
+
 // api
 #include "apitypes.h"
 #include "engravingapiv1.h"
@@ -237,14 +241,52 @@ QQmlListProperty<apiv1::Score> PluginAPI::scores()
 bool PluginAPI::writeScore(Score* s, const QString& name, const QString& ext)
 {
     if (!s || !s->score()) {
+        LOGW("PluginAPI::writeScore: no score provided");
         return false;
     }
 
-    UNUSED(name);
-    UNUSED(ext);
+    if (s->score() != currentScore()) {
+        LOGW("PluginAPI::writeScore: only writing the selected score is currently supported");
+        return false;
+    }
 
-    NOT_IMPLEMENTED;
-    return false;
+    const notation::INotationPtr notation = context()->currentNotation();
+
+    if (!notation) {
+        LOGW("PluginAPI::writeScore: no notation found");
+        return false;
+    }
+
+    const auto unitType = determineWriterUnitType(ext.toStdString());
+
+    if (!unitType) {
+        LOGW("PluginAPI::writeScore: '%s' format is not supported", ext.toUtf8().constData());
+        return false;
+    }
+
+    const QString outPath = name.endsWith(ext) ? name : (name + '.' + ext);
+    return exportProjectScenario()->exportScores({ notation }, outPath, *unitType, /* openDestinationFolderOnExport */ false);
+}
+
+std::optional<project::INotationWriter::UnitType> PluginAPI::determineWriterUnitType(const std::string& ext) const
+{
+    const project::INotationWriterPtr writer = writers()->writer(ext);
+
+    if (!writer) {
+        return std::nullopt;
+    }
+
+    project::INotationWriter::UnitType unitType;
+
+    if (writer->supportsUnitType(project::INotationWriter::UnitType::PER_PAGE)) {
+        unitType = project::INotationWriter::UnitType::PER_PAGE;
+    } else if (writer->supportsUnitType(project::INotationWriter::UnitType::PER_PART)) {
+        unitType = project::INotationWriter::UnitType::PER_PART;
+    } else {
+        unitType = project::INotationWriter::UnitType::MULTI_PART;
+    }
+
+    return unitType;
 }
 
 //---------------------------------------------------------
@@ -259,11 +301,21 @@ bool PluginAPI::writeScore(Score* s, const QString& name, const QString& ext)
 
 apiv1::Score* PluginAPI::readScore(const QString& name, bool noninteractive)
 {
-    UNUSED(name);
-    UNUSED(noninteractive);
+    const bool hadScoreOpened = currentScore();
 
-    NOT_IMPLEMENTED;
-    return nullptr;
+    if (hadScoreOpened) {
+        LOGW("PluginAPI::readScore: will open a score in a new window");
+    }
+
+    if (noninteractive) {
+        LOGW("PluginAPI::readScore: noninteractive flag is not yet implemented");
+    }
+
+    const muse::io::path_t path(name);
+    const project::ProjectFile file(path);
+    const muse::Ret ret = projectFilesController()->openProject(file);
+
+    return (ret.success() && !hadScoreOpened) ? curScore() : nullptr;
 }
 
 //---------------------------------------------------------
@@ -272,9 +324,17 @@ apiv1::Score* PluginAPI::readScore(const QString& name, bool noninteractive)
 
 void PluginAPI::closeScore(apiv1::Score* score)
 {
-    UNUSED(score);
+    if (!score || !score->score()) {
+        LOGW("PluginAPI::closeScore: no score provided");
+        return;
+    }
 
-    NOT_IMPLEMENTED;
+    if (score->score() != currentScore()) {
+        LOGW("PluginAPI::closeScore: only closing the selected score is currently supported");
+        return;
+    }
+
+    projectFilesController()->closeOpenedProject();
 }
 
 //---------------------------------------------------------

src/engraving/api/v1/qmlpluginapi.h

@@ -31,6 +31,13 @@
 #include "global/iapplication.h"
 
 #include "enums.h"
+#include "engraving/dom/score.h"
+#include "engraving/dom/types.h"
+#include "engraving/types/types.h"
+#include "project/iexportprojectscenario.h"
+#include "project/inotationwritersregister.h"
+#include "project/iprojectfilescontroller.h"
+
 #include "apitypes.h"
 #include "cursor.h"
 
@@ -89,6 +96,12 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
 {
     Q_OBJECT
 
+    INJECT(muse::actions::IActionsDispatcher, actionsDispatcher)
+    INJECT(mu::context::IGlobalContext, context)
+    INJECT(mu::project::INotationWritersRegister, writers)
+    INJECT(mu::project::IExportProjectScenario, exportProjectScenario)
+    INJECT(mu::project::IProjectFilesController, projectFilesController)
+
     /** Path where the plugin is placed in menu */
     Q_PROPERTY(QString menuPath READ menuPath WRITE setMenuPath)
     /** Title of this plugin */
@@ -129,9 +142,9 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
     /** List of currently open scores (read only).\n \since MuseScore 3.2 */
     Q_PROPERTY(QQmlListProperty<mu::engraving::apiv1::Score> scores READ scores)
 
-public:
-    muse::Inject<muse::actions::IActionsDispatcher> actionsDispatcher = { this };
     muse::Inject<mu::context::IGlobalContext> context = { this };
+
+public:
     muse::Inject<muse::IApplication> application = { this };
 
 public:
@@ -537,6 +550,7 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
     QString m_thumbnailName;
     QString m_categoryCode;
     muse::async::Notification m_closeRequested;
+    std::optional<project::INotationWriter::UnitType> determineWriterUnitType(const std::string& ext) const;
 };
 
 #undef DECLARE_API_ENUM2

src/project/CMakeLists.txt

@@ -50,6 +50,7 @@ set(MODULE_SRC
     ${CMAKE_CURRENT_LIST_DIR}/projectmodule.h
     ${CMAKE_CURRENT_LIST_DIR}/projecterrors.h
     ${CMAKE_CURRENT_LIST_DIR}/projectextensionpoints.h
+    ${CMAKE_CURRENT_LIST_DIR}/iexportprojectscenario.h
     ${CMAKE_CURRENT_LIST_DIR}/inotationproject.h
     ${CMAKE_CURRENT_LIST_DIR}/iprojectcreator.h
     ${CMAKE_CURRENT_LIST_DIR}/inotationreader.h
@@ -89,7 +90,6 @@ set(MODULE_SRC
     ${CMAKE_CURRENT_LIST_DIR}/internal/projectconfiguration.h
     ${CMAKE_CURRENT_LIST_DIR}/internal/exporttype.cpp
     ${CMAKE_CURRENT_LIST_DIR}/internal/exporttype.h
-    ${CMAKE_CURRENT_LIST_DIR}/internal/iexportprojectscenario.h
     ${CMAKE_CURRENT_LIST_DIR}/internal/exportprojectscenario.cpp
     ${CMAKE_CURRENT_LIST_DIR}/internal/exportprojectscenario.h
     ${CMAKE_CURRENT_LIST_DIR}/internal/iopensaveprojectscenario.h

…roject/internal/iexportprojectscenario.h src/project/iexportprojectscenario.hsrc/project/internal/iexportprojectscenario.h renamed to src/project/iexportprojectscenario.h src/project/internal/iexportprojectscenario.h renamed to src/project/iexportprojectscenario.h

@@ -25,7 +25,7 @@
 #include "modularity/imoduleinterface.h"
 #include "notation/inotation.h"
 #include "inotationwriter.h"
-#include "exporttype.h"
+#include "internal/exporttype.h"
 #include "types/projecttypes.h"
 
 namespace mu::project {

src/project/internal/exportprojectscenario.cpp

@@ -228,6 +228,9 @@ bool ExportProjectScenario::exportScores(const notation::INotationPtrList& notat
     } break;
     case INotationWriter::UnitType::MULTI_PART: {
         auto exportFunction = [writer, notations, options](IODevice& destinationDevice) {
+                if (notations.size() == 1) {
+                    return writer->write(notations.front(), destinationDevice, options);
+                }
                 return writer->writeList(notations, destinationDevice, options);
             };
 

src/project/internal/projectactionscontroller.h

@@ -37,11 +37,11 @@
 #include "cloud/audiocom/iaudiocomservice.h"
 #include "playback/iplaybackcontroller.h"
 #include "print/iprintprovider.h"
+#include "iexportprojectscenario.h"
 #include "inotationreadersregister.h"
 #include "iopensaveprojectscenario.h"
 #include "imscmetareader.h"
 #include "io/ifilesystem.h"
-#include "internal/iexportprojectscenario.h"
 #include "notation/inotationconfiguration.h"
 #include "musesounds/imusesoundscheckupdatescenario.h"
 #include "extensions/iextensionsprovider.h"

src/project/view/exportdialogmodel.h

@@ -36,9 +36,9 @@
 #include "importexport/audioexport/iaudioexportconfiguration.h"
 #include "importexport/mei/imeiconfiguration.h"
 
+#include "iexportprojectscenario.h"
 #include "inotationwritersregister.h"
 #include "iprojectconfiguration.h"
-#include "internal/iexportprojectscenario.h"
 #include "types/projecttypes.h"
 
 class QItemSelectionModel;