ENG-54: Default HideMode::INSTRUMENT XML import

Since HideMode::AUTO behaves in uncommon ways for most scores (hiding empty staves in a grand staff), this changes the hideWhenEmpty to INSTRUMENT when creating the Staffs upon import. In the case that a score part has a variable number of staves, it uses this to infer that we do truly want HideMode::AUTO. Duplicate of musescore#8430, part 1
Jojo-Schmitz · Jun 29, 2021 · 820cc1c · 820cc1c
1 parent 833c0b2
commit 820cc1c
Show file tree

Hide file tree

Showing 19 changed files with 3,462 additions and 1 deletion.
diff --git a/importexport/musicxml/importmxmlpass1.cpp b/importexport/musicxml/importmxmlpass1.cpp
@@ -1650,6 +1650,7 @@ static void createPart(Score* score, const QString& id, PartMap& pm)
       score->appendPart(part);
       Staff* staff = new Staff(score);
       staff->setPart(part);
+      staff->setHideWhenEmpty(Staff::HideMode::INSTRUMENT);
       part->staves()->push_back(staff);
       score->staves().push_back(staff);
       // TODO TBD tuplets.resize(VOICES); // part now contains one staff, thus VOICES voices
@@ -2018,13 +2019,27 @@ void MusicXMLParserPass1::midiInstrument(const QString& partId)
 /**
  Set number of staves for part \a partId to the max value
  of the current value \a staves.
+ Also handle HideMode.
  */
 
 static void setNumberOfStavesForPart(Part* const part, const int staves)
       {
       Q_ASSERT(part);
-      if (staves > part->nstaves())
+      int prevnstaves = part->nstaves();
+      if (staves > part->nstaves()) {
             part->setStaves(staves);
+            // New staves default to INSTRUMENT hide mode
+            for (int i = prevnstaves; i < staves; ++i)
+                  part->staff(i)->setHideWhenEmpty(Staff::HideMode::INSTRUMENT);
+            }
+      if (staves != 0 && prevnstaves != 1 && prevnstaves != staves ) {
+            for (int i = 0; i < part->nstaves(); ++i) {
+                  // A "staves" value different from the existing nstaves means
+                  // staves in a part will sometimes be hidden.
+                  // We can approximate this with the AUTO hide mode.
+                  part->staff(i)->setHideWhenEmpty(Staff::HideMode::AUTO);
+                  }
+            }
       }
 
 //---------------------------------------------------------

diff --git a/mtest/musicxml/io/testArticulationsCombined_ref.mscx b/mtest/musicxml/io/testArticulationsCombined_ref.mscx
@@ -56,6 +56,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testBarlinesGrandStaff_ref.mscx b/mtest/musicxml/io/testBarlinesGrandStaff_ref.mscx
@@ -27,13 +27,15 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         <bracket type="1" span="2" col="1"/>
         <barLineSpan>2</barLineSpan>
         </Staff>
       <Staff id="2">
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testCueNotes3_ref.mscx b/mtest/musicxml/io/testCueNotes3_ref.mscx
@@ -57,6 +57,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Voice</trackName>
       <Instrument id="voice">

diff --git a/mtest/musicxml/io/testFretDiagramLayoutOrder_ref.mscx b/mtest/musicxml/io/testFretDiagramLayoutOrder_ref.mscx
@@ -56,6 +56,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testFretboardDiagrams_ref.mscx b/mtest/musicxml/io/testFretboardDiagrams_ref.mscx
@@ -57,6 +57,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testLyricExtensions_ref.mscx b/mtest/musicxml/io/testLyricExtensions_ref.mscx
@@ -27,6 +27,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testNegativeOffset_ref.mscx b/mtest/musicxml/io/testNegativeOffset_ref.mscx
@@ -56,13 +56,15 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         <bracket type="1" span="2" col="1"/>
         <barLineSpan>2</barLineSpan>
         </Staff>
       <Staff id="2">
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testPartNames_ref.mscx b/mtest/musicxml/io/testPartNames_ref.mscx
@@ -57,13 +57,15 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         <bracket type="1" span="2" col="1"/>
         <barLineSpan>2</barLineSpan>
         </Staff>
       <Staff id="2">
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">
@@ -126,6 +128,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Voice</trackName>
       <Instrument id="voice">
@@ -187,6 +190,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>P3</trackName>
       <Instrument id="bass">

diff --git a/mtest/musicxml/io/testPedalChangesBroken_ref.mscx b/mtest/musicxml/io/testPedalChangesBroken_ref.mscx
@@ -56,6 +56,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">

diff --git a/mtest/musicxml/io/testPedalChanges_ref.mscx b/mtest/musicxml/io/testPedalChanges_ref.mscx
@@ -56,6 +56,7 @@
         <StaffType group="pitched">
           <name>stdNormal</name>
           </StaffType>
+        <hideWhenEmpty>3</hideWhenEmpty>
         </Staff>
       <trackName>Piano</trackName>
       <Instrument id="piano">