Fix #23792 Add/remove page breaks

Author: pacebes

src/appshell/view/appmenumodel.cpp

@@ -318,6 +318,7 @@ MenuItem* AppMenuModel::makeFormatMenu()
         makeMenuItem("page-settings"),
         makeSeparator(),
         makeMenuItem("measures-per-system"),
+        makeMenuItem("add-remove-page-breaks"),
         makeMenu(TranslatableString("appshell/menu/format", "Str&etch"), stretchItems, "menu-stretch"),
         makeSeparator(),
         makeMenuItem("reset-text-style-overrides"),

src/engraving/dom/cmd.cpp

@@ -4407,6 +4407,78 @@ void Score::addRemoveSystemLocks(int interval, bool lock)
     }
 }
 
+void Score::addRemovePageBreaks(int interval, bool afterEachPage)
+{
+    Segment* startSegment = selection().startSegment();
+    if (!startSegment) { // empty score?
+        return;
+    }
+    Segment* endSegment = selection().endSegment();
+    Measure* startMeasure = startSegment->measure();
+    Measure* endMeasure = endSegment ? endSegment->measure() : lastMeasureMM();
+    Measure* lastMeasure = lastMeasureMM();
+
+    // loop through measures in selection
+    // First system
+    int sCount = 1;
+    for (Measure* mm = startMeasure; mm; mm = mm->nextMeasureMM()) {
+        // even though we are counting mmrests as a single measure,
+        // we need to find last real measure within mmrest for the actual break
+        Measure* m = mm->isMMRest() ? mm->mmRestLast() : mm;
+
+        if (afterEachPage) {
+            // skip last measure of score
+            if (mm == lastMeasure) {
+                break;
+            }
+            // skip if it already has a page break
+            if (m->pageBreak()) {
+                continue;
+            }
+            // add break if last measure of the last system of the page
+            if (mm->system() && mm->system()->lastMeasure() == mm && mm->nextMeasureMM() && mm->nextMeasureMM()->system()
+                && mm->system()->page() != mm->nextMeasureMM()->system()->page()) {
+                m->undoSetPageBreak(true);
+            }
+        } else {
+            if (interval == 0) {
+                // remove page break if present
+                if (m->pageBreak()) {
+                    m->undoSetPageBreak(false);
+                }
+            } else {
+                if (sCount == interval) {
+                    // skip last measure of score and measures that aren't the last of the System
+                    if (mm == lastMeasure) {
+                        break;
+                    }
+
+                    // found place for break
+                    if (mm->system()->lastMeasure() == mm) {
+                        // add if not already one present
+                        if (!m->pageBreak()) {
+                            m->undoSetPageBreak(true);
+                        }
+                        // reset count
+                        sCount = 1;
+                    }
+                } else if (m->pageBreak()) {
+                    // remove page break if present in wrong place
+                    m->undoSetPageBreak(false);
+                }
+                // count if the last Measure of the system
+                if (!m->pageBreak() && mm->system() && mm->system()->lastMeasure() == mm) {
+                    ++sCount;
+                }
+            }
+        }
+
+        if (mm == endMeasure) {
+            break;
+        }
+    }
+}
+
 //---------------------------------------------------------
 //   cmdRemoveEmptyTrailingMeasures
 //---------------------------------------------------------

src/engraving/dom/score.h

@@ -405,6 +405,8 @@ class Score : public EngravingObject, public muse::Injectable
 
     void addRemoveSystemLocks(int interval, bool lock);
 
+    void addRemovePageBreaks(int interval, bool afterEachPage);
+
     bool transpose(Note* n, Interval, bool useSharpsFlats);
     void transposeKeys(staff_idx_t staffStart, staff_idx_t staffEnd, const Fraction& tickStart, const Fraction& tickEnd, bool flip = false);
     bool transpose(TransposeMode mode, TransposeDirection, Key transposeKey, int transposeInterval, bool trKeys, bool transposeChordNames,

src/notation/inotationinteraction.h

@@ -219,6 +219,7 @@ class INotationInteraction
     virtual void applySystemLock() = 0;
 
     virtual void addRemoveSystemLocks(AddRemoveSystemLockType intervalType, int interval = 0) = 0;
+    virtual void addRemovePageBreaks(AddRemovePageBreaksType intervalType, int interval = 0) = 0;
     virtual bool transpose(const TransposeOptions& options) = 0;
     virtual void swapVoices(voice_idx_t voiceIndex1, voice_idx_t voiceIndex2) = 0;
     virtual void addIntervalToSelectedNotes(int interval) = 0;

src/notation/internal/notationactioncontroller.cpp

@@ -304,6 +304,7 @@ void NotationActionController::init()
     registerAction("staff-properties", &Controller::openStaffProperties);
     registerAction("edit-strings", &Controller::openEditStringsDialog);
     registerAction("measures-per-system", &Controller::openBreaksDialog);
+    registerAction("add-remove-page-breaks", &Controller::openPageBreaksDialog);
     registerAction("transpose", &Controller::openTransposeDialog);
     registerAction("parts", &Controller::openPartsDialog);
     registerAction("staff-text-properties", &Controller::openStaffTextPropertiesDialog);
@@ -1810,6 +1811,11 @@ void NotationActionController::openBreaksDialog()
     interactive()->open("musescore://notation/breaks");
 }
 
+void NotationActionController::openPageBreaksDialog()
+{
+    interactive()->open("musescore://notation/pagebreaks");
+}
+
 void NotationActionController::openTransposeDialog()
 {
     interactive()->open("musescore://notation/transpose");

src/notation/internal/notationactioncontroller.h

@@ -152,6 +152,7 @@ class NotationActionController : public muse::actions::Actionable, public muse::
     void openStaffProperties();
     void openEditStringsDialog();
     void openBreaksDialog();
+    void openPageBreaksDialog();
     void openTransposeDialog();
     void openPartsDialog();
     void openTupletOtherDialog();

src/notation/internal/notationinteraction.cpp

@@ -5466,6 +5466,16 @@ void NotationInteraction::addRemoveSystemLocks(AddRemoveSystemLockType intervalT
     apply();
 }
 
+void NotationInteraction::addRemovePageBreaks(AddRemovePageBreaksType intervalType, int interval)
+{
+    interval = intervalType == AddRemovePageBreaksType::SystemsInterval ? interval : 0;
+    bool afterEachPage = intervalType == AddRemovePageBreaksType::AfterEachPage;
+
+    startEdit(TranslatableString("undoableAction", "Add / remove page breaks"));
+    score()->addRemovePageBreaks(interval, afterEachPage);
+    apply();
+}
+
 bool NotationInteraction::transpose(const TransposeOptions& options)
 {
     startEdit(TranslatableString("undoableAction", "Transposition"));

src/notation/internal/notationinteraction.h

@@ -224,6 +224,7 @@ class NotationInteraction : public INotationInteraction, public muse::Injectable
     void applySystemLock() override;
 
     void addRemoveSystemLocks(AddRemoveSystemLockType intervalType, int interval = 0) override;
+    void addRemovePageBreaks(AddRemovePageBreaksType intervalType, int interval = 0) override;
     bool transpose(const TransposeOptions& options) override;
     void swapVoices(voice_idx_t voiceIndex1, voice_idx_t voiceIndex2) override;
     void addIntervalToSelectedNotes(int interval) override;

src/notation/internal/notationuiactions.cpp

@@ -563,6 +563,12 @@ const UiActionList NotationUiActions::m_actions = {
              TranslatableString("action", "Measure properties…"),
              TranslatableString("action", "Measure properties…")
              ),
+    UiAction("add-remove-page-breaks",
+             mu::context::UiCtxProjectOpened,
+             mu::context::CTX_NOTATION_OPENED,
+             TranslatableString("action", "Add / remove page breaks…"),
+             TranslatableString("action", "Add / remove page breaks…")
+             ),
     UiAction("measures-per-system",
              mu::context::UiCtxProjectOpened,
              mu::context::CTX_NOTATION_OPENED,

src/notation/notationmodule.cpp

@@ -62,6 +62,7 @@
 #include "view/widgets/editstaff.h"
 #include "view/widgets/editstringdata.h"
 #include "view/widgets/breaksdialog.h"
+#include "view/widgets/pagebreaksdialog.h"
 #include "view/widgets/pagesettings.h"
 #include "view/widgets/transposedialog.h"
 #include "view/widgets/selectnotedialog.h"
@@ -148,6 +149,7 @@ void NotationModule::resolveImports()
         ir->registerWidgetUri<PageSettings>(Uri("musescore://notation/pagesettings"));
         ir->registerWidgetUri<MeasurePropertiesDialog>(Uri("musescore://notation/measureproperties"));
         ir->registerWidgetUri<BreaksDialog>(Uri("musescore://notation/breaks"));
+        ir->registerWidgetUri<PageBreaksDialog>(Uri("musescore://notation/pagebreaks"));
         ir->registerWidgetUri<EditStaff>(Uri("musescore://notation/staffproperties"));
         ir->registerWidgetUri<EditStringData>(Uri("musescore://notation/editstrings"));
         ir->registerWidgetUri<TransposeDialog>(Uri("musescore://notation/transpose"));

src/notation/notationtypes.h

@@ -197,6 +197,13 @@ enum class AddRemoveSystemLockType : signed char
     MeasuresInterval
 };
 
+enum class AddRemovePageBreaksType : signed char
+{
+    AfterEachPage = -1,
+    None = 0,
+    SystemsInterval
+};
+
 enum class BoxType : unsigned char
 {
     Unknown,

src/notation/tests/mocks/notationinteractionmock.h

@@ -182,6 +182,7 @@ class NotationInteractionMock : public INotationInteraction
     MOCK_METHOD(void, applySystemLock, (), (override));
 
     MOCK_METHOD(void, addRemoveSystemLocks, (AddRemoveSystemLockType, int), (override));
+    MOCK_METHOD(void, addRemovePageBreaks, (AddRemovePageBreaksType, int), (override));
     MOCK_METHOD(bool, transpose, (const TransposeOptions&), (override));
     MOCK_METHOD(void, swapVoices, (voice_idx_t, voice_idx_t), (override));
     MOCK_METHOD(void, addIntervalToSelectedNotes, (int), (override));

src/notation/view/widgets/pagebreaksdialog.cpp

@@ -0,0 +1,109 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-Studio-CLA-applies
+ *
+ * MuseScore Studio
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2021 MuseScore Limited
+ *
+ * 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/>.
+ */
+
+#include "pagebreaksdialog.h"
+
+using namespace mu::notation;
+
+static constexpr int DEFAULT_INTERVAL = 4;
+
+//---------------------------------------------------------
+//   PageBreaksDialog
+//---------------------------------------------------------
+
+PageBreaksDialog::PageBreaksDialog(QWidget* parent)
+    : QDialog(parent), muse::Injectable(muse::iocCtxForQWidget(this))
+{
+    setupUi(this);
+    setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint);
+    intervalButton->setChecked(true);
+    intervalBox->setValue(DEFAULT_INTERVAL);
+
+    //: `%1` will be replaced with a number input field.
+    //: Text before it will appear before that number field, text after will appear after the field.
+    QString text = muse::qtrc("notation/add-remove-system-breaks", "Break pages every %1 systems");
+    QStringList pieces = text.split(QStringLiteral("%1"));
+
+    IF_ASSERT_FAILED(pieces.size() >= 2) {
+        return;
+    }
+
+    QString part1 = pieces[0].trimmed();
+    QString part2 = pieces[1].trimmed();
+    intervalButton->setText(part1);
+    intervalLabel2->setText(part2);
+}
+
+//---------------------------------------------------------
+//   accept
+//---------------------------------------------------------
+
+void PageBreaksDialog::accept()
+{
+    INotationPtr notation = context()->currentNotation();
+    if (!notation) {
+        return;
+    }
+
+    INotationInteractionPtr interaction = notation->interaction();
+
+    int interval = intervalButton->isChecked() ? intervalBox->value() : 0;
+    AddRemovePageBreaksType intervalType = AddRemovePageBreaksType::SystemsInterval;
+
+    if (removeButton->isChecked()) {
+        intervalType = AddRemovePageBreaksType::None;
+    } else if (pageBreaksButton->isChecked()) {
+        intervalType = AddRemovePageBreaksType::AfterEachPage;
+    }
+
+    interaction->addRemovePageBreaks(intervalType, interval);
+
+    if (_allSelected) {
+        interaction->clearSelection();
+    }
+
+    QDialog::accept();
+}
+
+//---------------------------------------------------------
+//   showEvent
+//---------------------------------------------------------
+
+void PageBreaksDialog::showEvent(QShowEvent* ev)
+{
+    INotationPtr notation = context()->currentNotation();
+    if (!notation) {
+        return;
+    }
+
+    INotationInteractionPtr interaction = notation->interaction();
+    INotationSelectionPtr selection = interaction->selection();
+
+    if (!selection->isRange()) {
+        interaction->selectAll();
+        _allSelected = true;
+    } else {
+        _allSelected = false;
+    }
+
+    QWidget::showEvent(ev);
+}

src/notation/view/widgets/pagebreaksdialog.h

@@ -0,0 +1,55 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-Studio-CLA-applies
+ *
+ * MuseScore Studio
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2021 MuseScore Limited
+ *
+ * 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 MU_NOTATION_PAGEBREAKSDIALOG_H
+#define MU_NOTATION_PAGEBREAKSDIALOG_H
+
+#include "ui_pagebreaksdialog.h"
+
+#include "context/iglobalcontext.h"
+#include "modularity/ioc.h"
+
+namespace mu::notation {
+//---------------------------------------------------------
+//   PageBreaksDialog
+//---------------------------------------------------------
+
+class PageBreaksDialog : public QDialog, public Ui::PageBreaksDialog, public muse::Injectable
+{
+    Q_OBJECT
+
+    muse::Inject<context::IGlobalContext> context = { this };
+
+public:
+    PageBreaksDialog(QWidget* parent = nullptr);
+
+private slots:
+    void accept() override;
+
+private:
+    void showEvent(QShowEvent*) override;
+
+    bool _allSelected = false;
+};
+}
+
+#endif // MU_NOTATION_PAGEBREAKSDIALOG_H