Merge branch 'develop' into develop-pypi

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
 ## [unreleased]
+* Support (initial) for Volpiano input
+* Support for neumatic notation oriscus and quilisma
+* Support for neume layout without facsimile
+* Support for numeral harmonics in MusicXML importer (@eNote-GmBH)
 
 ## [4.2.1] - 2024-05-07
 * Fix GitHub actions (Python release only)
@@ -9,6 +13,7 @@
 * Support for `fTrem@unitdur` (@eNote-GmbH)
 * Upgrade to C++20
 * Update of the Midifile library
+* Improved logging
 * Fix lyric position in MIDI output
 * Fix string formatting output with some locale configurations (@ammatwain)
 

include/vrv/barline.h

@@ -9,6 +9,7 @@
 #define __VRV_BARLINE_H__
 
 #include "atts_shared.h"
+#include "atts_visual.h"
 #include "layerelement.h"
 
 namespace vrv {
@@ -27,6 +28,7 @@ enum class BarLinePosition { None, Left, Right };
  */
 class BarLine : public LayerElement,
                 public AttBarLineLog,
+                public AttBarLineVis,
                 public AttColor,
                 public AttNNumberLike,
                 public AttVisibility {
@@ -76,9 +78,9 @@ class BarLine : public LayerElement,
      * @return First entry is true if the attribute was found, second entry contains the value
      */
     ///@{
-    std::pair<bool, double> GetLength(const StaffDef *staffDef) const;
-    std::pair<bool, data_BARMETHOD> GetMethod(const StaffDef *staffDef) const;
-    std::pair<bool, int> GetPlace(const StaffDef *staffDef) const;
+    std::pair<bool, double> GetLengthFromContext(const StaffDef *staffDef) const;
+    std::pair<bool, data_BARMETHOD> GetMethodFromContext(const StaffDef *staffDef) const;
+    std::pair<bool, int> GetPlaceFromContext(const StaffDef *staffDef) const;
     ///@}
 
     //----------//

include/vrv/divline.h

@@ -37,13 +37,13 @@ class DivLine : public LayerElement,
     ///@{
     DivLine();
     virtual ~DivLine();
-    virtual Object *Clone() const { return new DivLine(*this); }
-    virtual void Reset();
-    virtual std::string GetClassName() const { return "DivLine"; }
+    Object *Clone() const override { return new DivLine(*this); }
+    void Reset() override;
+    std::string GetClassName() const override { return "DivLine"; }
     ///@}
 
     /** Override the method since alignment is required */
-    virtual bool HasToBeAligned() const { return true; }
+    bool HasToBeAligned() const override { return true; }
 
     /**
      * Use to set the alignment for the Measure BarLine members.
@@ -84,8 +84,8 @@ class DivLineAttr : public DivLine {
     ///@{
     DivLineAttr();
     virtual ~DivLineAttr();
-    virtual Object *Clone() const { return new DivLineAttr(*this); }
-    virtual std::string GetClassName() const { return "DivLineAttr"; }
+    Object *Clone() const override { return new DivLineAttr(*this); }
+    std::string GetClassName() const override { return "DivLineAttr"; }
     ///@}
 
     // void SetLeft() { m_isLeft = true; }

include/vrv/elementpart.h

@@ -22,7 +22,7 @@ class TupletNum;
 //----------------------------------------------------------------------------
 
 /**
- * This class models a group of dots as a layer element part and has not direct MEI equivlatent.
+ * This class models a group of dots as a layer element part and has no direct MEI equivalent.
  */
 class Dots : public LayerElement, public AttAugmentDots {
 public:
@@ -92,7 +92,7 @@ class Dots : public LayerElement, public AttAugmentDots {
 //----------------------------------------------------------------------------
 
 /**
- * This class models a stem as a layer element part and has not direct MEI equivlatent.
+ * This class models a stem as a layer element part and has no direct MEI equivalent.
  */
 class Flag : public LayerElement {
 public:
@@ -144,7 +144,7 @@ class Flag : public LayerElement {
 //----------------------------------------------------------------------------
 
 /**
- * This class models a bracket as a layer element part and has not direct MEI equivlatent.
+ * This class models a bracket as a layer element part and has no direct MEI equivalent.
  * It is used to represent tuplet brackets.
  */
 class TupletBracket : public LayerElement, public AttTupletVis {
@@ -243,7 +243,7 @@ class TupletBracket : public LayerElement, public AttTupletVis {
 //----------------------------------------------------------------------------
 
 /**
- * This class models a tuplet num as a layer element part and has not direct MEI equivlatent.
+ * This class models a tuplet num as a layer element part and has no direct MEI equivalent.
  * It is used to represent tuplet number
  */
 class TupletNum : public LayerElement, public AttNumberPlacement, public AttTupletVis {

include/vrv/iohumdrum.h

@@ -900,6 +900,8 @@ class HumdrumInput : public vrv::Input {
     bool checkIfReversedSpineOrder(std::vector<hum::HTp> &staffstarts);
     bool hasOmdText(int startline, int endline);
     void processMeiOptions(hum::HumdrumFile &infile);
+    std::string getInstrumentNumber(hum::HTp icode);
+    void insertTextWithNewlines(Label *label, const std::string &text);
 
     // header related functions: ///////////////////////////////////////////
     void createHeader();

include/vrv/layerelement.h

@@ -80,7 +80,7 @@ class LayerElement : public Object,
 
     /**
      * Return true if the element has to be aligned horizontally
-     * It typically set to false for mRest, mRpt, etc.
+     * It is typically set to false for mRest, mRpt, etc.
      */
     virtual bool HasToBeAligned() const { return false; }
 

include/vrv/liquescent.h

@@ -29,20 +29,20 @@ class Liquescent : public LayerElement, public PitchInterface, public PositionIn
     ///@{
     Liquescent();
     virtual ~Liquescent();
-    virtual Object *Clone() const { return new Liquescent(*this); }
-    virtual void Reset();
-    virtual std::string GetClassName() const { return "Liquescent"; }
+    Object *Clone() const override { return new Liquescent(*this); }
+    void Reset() override;
+    std::string GetClassName() const override { return "Liquescent"; }
     ///@}
 
     /**
      * @name Getter to interfaces
      */
     ///@{
-    virtual PitchInterface *GetPitchInterface() { return dynamic_cast<PitchInterface *>(this); }
+    PitchInterface *GetPitchInterface() override { return dynamic_cast<PitchInterface *>(this); }
     ///@}
 
     /** Override the method since alignment is required */
-    virtual bool HasToBeAligned() const { return true; }
+    bool HasToBeAligned() const override { return true; }
 
 private:
     //

include/vrv/object.h

@@ -165,7 +165,7 @@ class Object : public BoundingBox {
     const Resources *GetDocResources() const;
 
     /**
-     * Reset the object, that is 1) removing all childs and 2) resetting all attributes.
+     * Reset the object, that is 1) removing all children and 2) resetting all attributes.
      * The method is virtual, so _always_ call the parent in the method overriding it.
      */
     virtual void Reset();
@@ -820,8 +820,8 @@ class Object : public BoundingBox {
 class ObjectListInterface {
 public:
     // constructors and destructors
-    ObjectListInterface(){};
-    virtual ~ObjectListInterface(){};
+    ObjectListInterface() = default;
+    virtual ~ObjectListInterface() = default;
     ObjectListInterface(const ObjectListInterface &listInterface); // copy constructor;
     ObjectListInterface &operator=(const ObjectListInterface &listInterface); // copy assignment;
 
@@ -919,8 +919,8 @@ class ObjectListInterface {
 class TextListInterface : public ObjectListInterface {
 public:
     // constructors and destructors
-    TextListInterface(){};
-    virtual ~TextListInterface(){};
+    TextListInterface() = default;
+    virtual ~TextListInterface() = default;
 
     /**
      * Returns a contatenated version of all the text children

include/vrv/oriscus.h

@@ -29,20 +29,20 @@ class Oriscus : public LayerElement, public PitchInterface, public PositionInter
     ///@{
     Oriscus();
     virtual ~Oriscus();
-    virtual Object *Clone() const { return new Oriscus(*this); }
-    virtual void Reset();
-    virtual std::string GetClassName() const { return "Oriscus"; }
+    Object *Clone() const override { return new Oriscus(*this); }
+    void Reset() override;
+    std::string GetClassName() const override { return "Oriscus"; }
     ///@}
 
     /**
      * @name Getter to interfaces
      */
     ///@{
-    virtual PitchInterface *GetPitchInterface() { return dynamic_cast<PitchInterface *>(this); }
+    PitchInterface *GetPitchInterface() override { return dynamic_cast<PitchInterface *>(this); }
     ///@}
 
     /** Override the method since alignment is required */
-    virtual bool HasToBeAligned() const { return true; }
+    bool HasToBeAligned() const override { return true; }
 
 private:
     //

include/vrv/quilisma.h

@@ -29,20 +29,20 @@ class Quilisma : public LayerElement, public PitchInterface, public PositionInte
     ///@{
     Quilisma();
     virtual ~Quilisma();
-    virtual Object *Clone() const { return new Quilisma(*this); }
-    virtual void Reset();
-    virtual std::string GetClassName() const { return "Quilisma"; }
+    Object *Clone() const override { return new Quilisma(*this); }
+    void Reset() override;
+    std::string GetClassName() const override { return "Quilisma"; }
     ///@}
 
     /**
      * @name Getter to interfaces
      */
     ///@{
-    virtual PitchInterface *GetPitchInterface() { return dynamic_cast<PitchInterface *>(this); }
+    PitchInterface *GetPitchInterface() override { return dynamic_cast<PitchInterface *>(this); }
     ///@}
 
     /** Override the method since alignment is required */
-    virtual bool HasToBeAligned() const { return true; }
+    bool HasToBeAligned() const override { return true; }
 
 private:
     //

include/vrv/staff.h

@@ -36,13 +36,8 @@ class LedgerLine {
 public:
     /**
      * @name Constructors, destructors, reset methods
-     * Reset method reset all attribute classes
      */
-    ///@{
-    LedgerLine();
-    virtual ~LedgerLine();
-    virtual void Reset();
-    ///@}
+    LedgerLine() = default;
 
     /**
      * Add a dash to the ledger line object.

include/vrv/toolkit.h

@@ -770,6 +770,22 @@ class Toolkit {
      */
     void ResetLogBuffer();
 
+    /**
+     * Start capturing std::cerr from an external codebase for redirection to vrv::logBuffer.
+     * Only one capture should be active at a given time.  Finish by calling LogRedirectStop.
+     */
+    void LogRedirectStart();
+
+    /**
+     * End capturing std::cerr from an external codebase for redirection to vrv::logBuffer.
+     */
+    void LogRedirectStop();
+
+    /**
+     * Load a string data with or without resetting the log buffer
+     */
+    bool LoadData(const std::string &data, bool resetLogBuffer);
+
 private:
     bool SetFont(const std::string &fontName);
     bool IsUTF16(const std::string &filename);
@@ -805,6 +821,18 @@ class Toolkit {
      */
     char *m_cString;
 
+    /**
+     * Temporary capture buffer for redirecting std::cerr to vrv::LogWarning.
+     * Used to coordinate between LogRedirectStart()/LogRedirectStop().
+     */
+    std::stringstream m_cerrCaptured;
+
+    /**
+     * Temporary storage of the std::cerr read buffer during LogCapture. NULL when not in use.
+     * Used to coordinate between LogRedirectStart()/LogRedirectStop().
+     */
+    std::streambuf *m_cerrOriginalBuf;
+
     EditorToolkit *m_editorToolkit;
 
 #ifndef NO_RUNTIME

include/vrv/vrv.h

@@ -145,7 +145,7 @@ extern bool loggingToBuffer;
  */
 extern struct timeval start;
 void LogElapsedTimeStart();
-void LogElapsedTimeEnd(const char *msg = "unspecified operation");
+void LogElapsedTimeStop(const char *msg = "unspecified operation");
 
 //----------------------------------------------------------------------------
 // Notation type checks

src/barline.cpp

@@ -33,19 +33,22 @@ namespace vrv {
 
 static const ClassRegistrar<BarLine> s_factory("barLine", BARLINE);
 
-BarLine::BarLine() : LayerElement(BARLINE, "bline-"), AttBarLineLog(), AttColor(), AttNNumberLike(), AttVisibility()
+BarLine::BarLine()
+    : LayerElement(BARLINE, "bline-"), AttBarLineLog(), AttBarLineVis(), AttColor(), AttNNumberLike(), AttVisibility()
 {
     this->RegisterAttClass(ATT_BARLINELOG);
+    this->RegisterAttClass(ATT_BARLINEVIS);
     this->RegisterAttClass(ATT_COLOR);
     this->RegisterAttClass(ATT_VISIBILITY);
 
     this->Reset();
 }
 
 BarLine::BarLine(ClassId classId)
-    : LayerElement(classId, "bline-"), AttBarLineLog(), AttColor(), AttNNumberLike(), AttVisibility()
+    : LayerElement(classId, "bline-"), AttBarLineLog(), AttBarLineVis(), AttColor(), AttNNumberLike(), AttVisibility()
 {
     this->RegisterAttClass(ATT_BARLINELOG);
+    this->RegisterAttClass(ATT_BARLINEVIS);
     this->RegisterAttClass(ATT_COLOR);
     this->RegisterAttClass(ATT_VISIBILITY);
 
@@ -59,6 +62,7 @@ void BarLine::Reset()
     LayerElement::Reset();
 
     this->ResetBarLineLog();
+    this->ResetBarLineVis();
     this->ResetColor();
     this->ResetVisibility();
 
@@ -91,7 +95,7 @@ bool BarLine::IsDrawnThrough(const StaffGrp *staffGrp) const
     return false;
 }
 
-std::pair<bool, double> BarLine::GetLength(const StaffDef *staffDef) const
+std::pair<bool, double> BarLine::GetLengthFromContext(const StaffDef *staffDef) const
 {
     // First check the parent measure
     const Measure *measure = dynamic_cast<const Measure *>(this->GetParent());
@@ -116,7 +120,7 @@ std::pair<bool, double> BarLine::GetLength(const StaffDef *staffDef) const
     return { false, 0.0 };
 }
 
-std::pair<bool, data_BARMETHOD> BarLine::GetMethod(const StaffDef *staffDef) const
+std::pair<bool, data_BARMETHOD> BarLine::GetMethodFromContext(const StaffDef *staffDef) const
 {
     // First check the parent measure
     const Measure *measure = dynamic_cast<const Measure *>(this->GetParent());
@@ -141,7 +145,7 @@ std::pair<bool, data_BARMETHOD> BarLine::GetMethod(const StaffDef *staffDef) con
     return { false, BARMETHOD_NONE };
 }
 
-std::pair<bool, int> BarLine::GetPlace(const StaffDef *staffDef) const
+std::pair<bool, int> BarLine::GetPlaceFromContext(const StaffDef *staffDef) const
 {
     // First check the parent measure
     const Measure *measure = dynamic_cast<const Measure *>(this->GetParent());

src/calcligatureorneumeposfunctor.cpp

@@ -347,16 +347,19 @@ FunctorCode CalcLigatureOrNeumePosFunctor::VisitNeume(Neume *neume)
             }
         }
 
-        // If the nc overlaps with the previous, move it back from a line width
-        if (overlapWithPrevious) {
-            xRel -= lineWidth;
-        }
+        // xRel remains unset with facsimile
+        if (!m_doc->HasFacsimile()) {
+            // If the nc overlaps with the previous, move it back from a line width
+            if (overlapWithPrevious) {
+                xRel -= lineWidth;
+            }
 
-        nc->SetDrawingXRel(xRel);
-        // The first glyph set the spacing - unless we are starting a ligature, in which case no spacing should be added
-        // between the two nc
-        if (!previousLig) {
-            xRel += m_doc->GetGlyphWidth(nc->m_drawingGlyphs.at(0).m_fontNo, staffSize, false);
+            nc->SetDrawingXRel(xRel);
+            // The first glyph set the spacing - unless we are starting a ligature, in which case no spacing should be
+            // added between the two nc
+            if (!previousLig) {
+                xRel += m_doc->GetGlyphWidth(nc->m_drawingGlyphs.at(0).m_fontNo, staffSize, false);
+            }
         }
 
         previousNc = nc;