setscoredeffunctor.h

// Name:        setscoredeffunctor.h
// Author:      David Bauer
// Created:     2022
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_SETSCOREDEFFUNCTOR_H__
#define __VRV_SETSCOREDEFFUNCTOR_H__
 
#include "functor.h"
 
namespace vrv {
 
//----------------------------------------------------------------------------
// ReplaceDrawingValuesInStaffDefFunctor
//----------------------------------------------------------------------------
 
class ReplaceDrawingValuesInStaffDefFunctor : public Functor {
public:
    ReplaceDrawingValuesInStaffDefFunctor(const Clef *clef, const KeySig *keySig, const Mensur *mensur,
        const MeterSig *meterSig, const MeterSigGrp *meterSigGrp);
    virtual ~ReplaceDrawingValuesInStaffDefFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitStaffDef(StaffDef *staffDef) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The clef (NULL if none)
    const Clef *m_clef;
    // The key signature (NULL if none)
    const KeySig *m_keySig;
    // The mensur (NULL if none)
    const Mensur *m_mensur;
    // The meter signature (NULL if none)
    const MeterSig *m_meterSig;
    // The meter signature group (NULL if none)
    const MeterSigGrp *m_meterSigGrp;
};
 
//----------------------------------------------------------------------------
// ScoreDefSetCurrentPageFunctor
//----------------------------------------------------------------------------
 
class ScoreDefSetCurrentPageFunctor : public DocFunctor {
public:
    ScoreDefSetCurrentPageFunctor(Doc *doc);
    virtual ~ScoreDefSetCurrentPageFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return true; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitPageEnd(Page *page) override;
    FunctorCode VisitScoreOrPartElement(ScoreOrPartElement *scoreOrPart) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The list of all scores
    std::list<ScoreOrPartElement *> m_scores;
};
 
//----------------------------------------------------------------------------
// ScoreDefSetCurrentFunctor
//----------------------------------------------------------------------------
 
class ScoreDefSetCurrentFunctor : public DocFunctor {
public:
    ScoreDefSetCurrentFunctor(Doc *doc);
    virtual ~ScoreDefSetCurrentFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return true; }
 
    /*
     * Getter for ossia flag
     */
    bool HasOssia() const { return m_hasOssia; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitClef(Clef *clef) override;
    FunctorCode VisitKeySig(KeySig *keySig) override;
    FunctorCode VisitLayer(Layer *layer) override;
    FunctorCode VisitMeasure(Measure *measure) override;
    FunctorCode VisitMensur(Mensur *mensur) override;
    FunctorCode VisitOssia(Ossia *ossia) override;
    FunctorCode VisitPage(Page *page) override;
    FunctorCode VisitProport(Proport *proport) override;
    FunctorCode VisitScoreOrPartElement(ScoreOrPartElement *scoreOrPart) override;
    FunctorCode VisitScoreDef(ScoreDef *scoreDef) override;
    FunctorCode VisitScoreDefEnd(ScoreDef *scoreDef) override;
    FunctorCode VisitStaff(Staff *staff) override;
    FunctorCode VisitStaffDef(StaffDef *staffDef) override;
    FunctorCode VisitStaffGrp(StaffGrp *staffGrp) override;
    FunctorCode VisitSystem(System *system) override;
    FunctorCode VisitSystemEnd(System *system) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The current score
    ScoreOrPartElement *m_currentScore;
    // The current scoreDef
    ScoreDef *m_currentScoreDef;
    // The current staffDef
    StaffDef *m_currentStaffDef;
    // The upcoming scoreDef
    ScoreDef m_upcomingScoreDef;
    // The previous measure (for setting cautionary scoreDef)
    Measure *m_previousMeasure;
    // The current system (for setting the system scoreDef)
    System *m_currentSystem;
    // Flag indicating whether full labels have to be drawn
    bool m_drawLabels;
    // Flag indicating that the scoreDef restarts (draw brace and label)
    bool m_restart;
    // Flag indicating if we already have a measure in the system
    bool m_hasMeasure;
    // Map of ossia above a given staffN
    MapOfOssiaStaffNs m_ossiasAbove;
    // Map of ossia below a given staffN
    MapOfOssiaStaffNs m_ossiasBelow;
    // Flag indicating if we need have ossias to process
    bool m_hasOssia;
};
 
//----------------------------------------------------------------------------
// ScoreDefOptimizeFunctor
//----------------------------------------------------------------------------
 
class ScoreDefOptimizeFunctor : public DocFunctor {
public:
    ScoreDefOptimizeFunctor(Doc *doc);
    virtual ~ScoreDefOptimizeFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return true; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitMeasure(Measure *measure) override;
    FunctorCode VisitScoreOrPartElement(ScoreOrPartElement *scoreOrPart) override;
    FunctorCode VisitStaff(Staff *staff) override;
    FunctorCode VisitStaffGrpEnd(StaffGrp *staffGrp) override;
    FunctorCode VisitSystem(System *system) override;
    FunctorCode VisitSystemEnd(System *system) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The current scoreDef
    ScoreDef *m_currentScoreDef;
    // Flag indicating if we are optimizing encoded layout
    bool m_encoded;
    // Flag indicating if we consider the first scoreDef
    bool m_firstScoreDef;
    // Flag indicating if a Fermata element is present
    bool m_hasFermata;
    // Flag indicating if a Tempo element is present
    bool m_hasTempo;
};
 
//----------------------------------------------------------------------------
// SetCautionaryScoreDefFunctor
//----------------------------------------------------------------------------
 
class SetCautionaryScoreDefFunctor : public Functor {
public:
    SetCautionaryScoreDefFunctor(ScoreDef *currentScoreDef, bool restart = false);
    virtual ~SetCautionaryScoreDefFunctor() = default;
 
    void SetRestartStaffNs(const std::vector<int> &staffNs) { m_staffNs = staffNs; }
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitLayer(Layer *layer) override;
    FunctorCode VisitStaff(Staff *staff) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The current scoreDef
    ScoreDef *m_currentScoreDef;
    // The current staffDef
    StaffDef *m_currentStaffDef;
    // Flag indicating we are processing a restart
    bool m_restart;
    // The list of staff n after the restart
    std::vector<int> m_staffNs;
};
 
//----------------------------------------------------------------------------
// ScoreDefSetGrpSymFunctor
//----------------------------------------------------------------------------
 
class ScoreDefSetGrpSymFunctor : public Functor {
public:
    ScoreDefSetGrpSymFunctor();
    virtual ~ScoreDefSetGrpSymFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitGrpSym(GrpSym *grpSym) override;
    FunctorCode VisitSystem(System *system) override;
 
protected:
    //
private:
    //
public:
    //
private:
    //
};
 
//----------------------------------------------------------------------------
// ScoreDefSetOssiaFunctor
//----------------------------------------------------------------------------
 
class ScoreDefSetOssiaFunctor : public DocFunctor {
public:
    ScoreDefSetOssiaFunctor(Doc *doc);
    virtual ~ScoreDefSetOssiaFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return true; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitClef(Clef *clef) override;
    FunctorCode VisitLayer(Layer *layer) override;
    FunctorCode VisitMeasure(Measure *measure) override;
    FunctorCode VisitMeasureEnd(Measure *measure) override;
    FunctorCode VisitOssia(Ossia *ossia) override;
    FunctorCode VisitStaff(Staff *staff) override;
    FunctorCode VisitStaffEnd(Staff *staff) override;
    FunctorCode VisitSystem(System *system) override;
 
protected:
    //
private:
    const StaffDef *GetPreviousStaffDef(Ossia *ossia, int staffN);
 
    class CurrentOssia {
    public:
        Ossia *m_ossia = NULL;
        std::map<int, StaffDef> m_staffDefs;
    };
 
public:
    //
private:
    // The current ossias (i.e., in the current measure)
    std::list<CurrentOssia> m_currentOssias;
    // The ossias in the previous measure
    std::list<CurrentOssia> m_previousOssias;
    // The upcoming staffDef
    StaffDef m_upcomingStaffDef;
    // The current scoreDef
    ScoreDef *m_currentScoreDef;
    // The current staffDef
    StaffDef *m_currentStaffDef;
    // A flag indicating the layer ossia staffDef will have to be drawn
    bool m_layerOssiaStaffDef;
    // Flag for first measure in the system
    bool m_isFirstMeasure;
};
 
//----------------------------------------------------------------------------
// ScoreDefUnsetCurrentFunctor
//----------------------------------------------------------------------------
 
class ScoreDefUnsetCurrentFunctor : public Functor {
public:
    ScoreDefUnsetCurrentFunctor();
    virtual ~ScoreDefUnsetCurrentFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitAlignmentReference(AlignmentReference *alignmentReference) override;
    FunctorCode VisitKeySig(KeySig *keySig) override;
    FunctorCode VisitLayer(Layer *layer) override;
    FunctorCode VisitMeasure(Measure *measure) override;
    FunctorCode VisitOssia(Ossia *ossia) override;
    FunctorCode VisitPage(Page *page) override;
    FunctorCode VisitStaff(Staff *staff) override;
    FunctorCode VisitSystem(System *system) override;
 
protected:
    //
private:
    //
public:
    //
private:
    //
};
 
//----------------------------------------------------------------------------
// SetStaffDefRedrawFlagsFunctor
//----------------------------------------------------------------------------
 
enum StaffDefRedrawFlags {
    REDRAW_CLEF = 0x1,
    REDRAW_KEYSIG = 0x2,
    REDRAW_MENSUR = 0x4,
    REDRAW_METERSIG = 0x8,
    REDRAW_METERSIGGRP = 0x10,
    // all flags
    REDRAW_ALL = REDRAW_CLEF | REDRAW_KEYSIG | REDRAW_MENSUR | REDRAW_METERSIG | REDRAW_METERSIGGRP,
    //
    FORCE_REDRAW = 0x100
};
 
class SetStaffDefRedrawFlagsFunctor : public Functor {
public:
    SetStaffDefRedrawFlagsFunctor(int redrawFlags);
    virtual ~SetStaffDefRedrawFlagsFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitStaffDef(StaffDef *staffDef) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The staffDef redraw flags
    int m_redrawFlags;
};
 
} // namespace vrv
 
#endif // __VRV_SETSCOREDEFFUNCTOR_H__