Merge pull request #4260 from rism-digital/develop-expand-doc

Add option to generate expansion from measure repeats

Author: lpugin

include/vrv/expansionmap.h

@@ -17,6 +17,9 @@
 
 namespace vrv {
 
+class Score;
+class Section;
+
 class ExpansionMap {
 
 public:
@@ -52,6 +55,25 @@ class ExpansionMap {
      */
     void ToJson(std::string &output);
 
+    /**
+     * Generate an expan for the score analysing the repeats and endings
+     */
+    void GenerateExpansionFor(Score *score);
+
+    //----------------//
+    // Static methods //
+    //----------------//
+
+    /**
+     * @name Methods to check if a measure yields a repeat start or end
+     */
+    ///@{
+    static bool IsRepeatStart(Measure *measure);
+    static bool IsRepeatEnd(Measure *measure);
+    static bool IsNextRepeatStart(Measure *measure);
+    static bool IsPreviousRepeatEnd(Measure *measure);
+    ///@}
+
 private:
     bool UpdateIDs(Object *object);
 
@@ -62,6 +84,9 @@ class ExpansionMap {
     /** Ads an id string to an original/notated id */
     bool AddExpandedIDToExpansionMap(const std::string &origXmlId, std::string newXmlId);
 
+    std::string CreateSection(
+        Section *section, const ListOfObjects::iterator &first, const ListOfObjects::iterator &last);
+
 public:
     /** The expansion map indicates which xmlId has been repeated (expanded) elsewhere */
     std::map<std::string, std::vector<std::string>> m_map;

include/vrv/options.h

@@ -631,8 +631,6 @@ class Options {
     OptionBool m_condenseNotLastSystem;
     OptionBool m_condenseTempoPages;
     OptionBool m_evenNoteSpacing;
-    OptionString m_expand;
-    OptionBool m_expandFirst;
     OptionIntMap m_footer;
     OptionIntMap m_header;
     OptionBool m_humType;
@@ -774,6 +772,9 @@ class Options {
 
     OptionArray m_appXPathQuery;
     OptionArray m_choiceXPathQuery;
+    OptionString m_expand;
+    OptionBool m_expandFirst;
+    OptionBool m_expandGenerate;
     OptionBool m_loadSelectedMdivOnly;
     OptionBool m_mdivAll;
     OptionString m_mdivXPathQuery;

src/doc.cpp

@@ -1609,6 +1609,19 @@ void Doc::ExpandExpansions()
     // Upon MEI import: use expansion ID or boolean for first expansion, given by command line argument
     std::string expansionId = this->GetOptions()->m_expand.GetValue();
     bool expandFirst = this->GetOptions()->m_expandFirst.GetValue();
+
+    if (this->GetOptions()->m_expandGenerate.GetValue()) {
+        ExpansionMap expansionMap;
+        ListOfObjects scores = this->FindAllDescendantsByType(SCORE);
+        for (Object *object : scores) {
+            Score *score = vrv_cast<Score *>(object);
+            assert(score);
+            expansionMap.GenerateExpansionFor(score);
+        }
+        // Enable expansion of first one when generated
+        expandFirst = true;
+    }
+
     if (expansionId.empty() && !expandFirst) return;
 
     Expansion *startExpansion = NULL;

src/expansionmap.cpp

@@ -19,8 +19,10 @@
 #include "expansion.h"
 #include "lem.h"
 #include "linkinginterface.h"
+#include "measure.h"
 #include "plistinterface.h"
 #include "rdg.h"
+#include "score.h"
 #include "section.h"
 #include "timeinterface.h"
 #include "vrv.h"
@@ -362,4 +364,111 @@ void ExpansionMap::ToJson(std::string &output)
     output = expansionmap.json();
 }
 
+void ExpansionMap::GenerateExpansionFor(Score *score)
+{
+    if (score->FindDescendantByType(EXPANSION)) {
+        LogWarning("An expansion cannot be generated if one is already encoded");
+        return;
+    }
+
+    if (score->HasEditorialContent()) {
+        LogWarning("An expansion cannot be generated with editorial content");
+        return;
+    }
+
+    if (score->FindAllDescendantsByType(SECTION).size() > 1) {
+        LogWarning("An expansion cannot be generated with more than one section");
+        return;
+    }
+
+    Section *section = vrv_cast<Section *>(score->FindDescendantByType(SECTION, 1));
+    assert(section);
+
+    ArrayOfObjects childrenArray = section->GetChildrenForModification();
+    ListOfObjects children(childrenArray.begin(), childrenArray.end());
+
+    Expansion *expansion = new Expansion();
+    section->InsertChild(expansion, 0);
+
+    ListOfObjects::iterator first = children.begin();
+    ListOfObjects::iterator last = children.begin();
+
+    bool isStartFromPrevious = false;
+
+    for (auto current = children.begin(); current != children.end(); current++) {
+        if ((*current)->Is(MEASURE)) {
+            Measure *measure = vrv_cast<Measure *>(*current);
+            // The current measure has a repeat end on its left
+            if (ExpansionMap::IsPreviousRepeatEnd(measure)) {
+                std::string ref = "#" + this->CreateSection(section, first, last);
+                expansion->GetPlistInterface()->AddRefAllowDuplicate(ref);
+                expansion->GetPlistInterface()->AddRefAllowDuplicate(ref);
+            }
+            if (isStartFromPrevious || ExpansionMap::IsRepeatStart(measure)) {
+                first = current;
+            }
+            // The current measure has a repeat start on its right
+            isStartFromPrevious = ExpansionMap::IsNextRepeatStart(measure);
+            last = current;
+            if (ExpansionMap::IsRepeatEnd(measure)) {
+                std::string ref = "#" + this->CreateSection(section, first, last);
+                expansion->GetPlistInterface()->AddRefAllowDuplicate(ref);
+                expansion->GetPlistInterface()->AddRefAllowDuplicate(ref);
+            }
+        }
+    }
+}
+
+std::string ExpansionMap::CreateSection(
+    Section *section, const ListOfObjects::iterator &first, const ListOfObjects::iterator &last)
+{
+    Section *subSection = new Section();
+    section->InsertBefore(*first, subSection);
+    for (auto sectionCurrent = first; sectionCurrent != std::next(last); sectionCurrent++) {
+        section->DetachChild((*sectionCurrent)->GetIdx());
+        subSection->AddChild(*sectionCurrent);
+    }
+    return subSection->GetID();
+}
+
+//----------------------------------------------------------------------------
+// Static methods
+//----------------------------------------------------------------------------
+
+bool ExpansionMap::IsRepeatStart(Measure *measure)
+{
+    static const std::vector<data_BARRENDITION> match{ BARRENDITION_rptboth, BARRENDITION_rptstart };
+
+    if (!measure->HasLeft()) return false;
+
+    return (std::find(match.begin(), match.end(), measure->GetLeft()) != match.end());
+}
+
+bool ExpansionMap::IsRepeatEnd(Measure *measure)
+{
+    static const std::vector<data_BARRENDITION> match{ BARRENDITION_rptboth, BARRENDITION_rptend };
+
+    if (!measure->HasRight()) return false;
+
+    return (std::find(match.begin(), match.end(), measure->GetRight()) != match.end());
+}
+
+bool ExpansionMap::IsNextRepeatStart(Measure *measure)
+{
+    static const std::vector<data_BARRENDITION> match{ BARRENDITION_rptboth, BARRENDITION_rptstart };
+
+    if (!measure->HasRight()) return false;
+
+    return (std::find(match.begin(), match.end(), measure->GetRight()) != match.end());
+}
+
+bool ExpansionMap::IsPreviousRepeatEnd(Measure *measure)
+{
+    static const std::vector<data_BARRENDITION> match{ BARRENDITION_rptboth, BARRENDITION_rptend };
+
+    if (!measure->HasLeft()) return false;
+
+    return (std::find(match.begin(), match.end(), measure->GetLeft()) != match.end());
+}
+
 } // namespace vrv

src/options.cpp

@@ -1593,6 +1593,10 @@ Options::Options()
     m_expandFirst.Init(false);
     this->Register(&m_expandFirst, "expandFirst", &m_selectors);
 
+    m_expandGenerate.SetInfo("Generate expansion", "Generate an expansion based on repeats");
+    m_expandGenerate.Init(false);
+    this->Register(&m_expandGenerate, "expandGenerate", &m_selectors);
+
     m_loadSelectedMdivOnly.SetInfo(
         "Load selected Mdiv only", "Load only the selected mdiv; the content of the other is skipped");
     m_loadSelectedMdivOnly.Init(false);