transposefunctor.h

// Name:        transposefunctor.h
// Author:      David Bauer
// Created:     2023
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_TRANSPOSEFUNCTOR_H__
#define __VRV_TRANSPOSEFUNCTOR_H__
 
#include "functor.h"
 
namespace vrv {
 
//----------------------------------------------------------------------------
// TransposeFunctor
//----------------------------------------------------------------------------
 
class TransposeFunctor : public DocFunctor {
public:
    TransposeFunctor(Doc *doc, Transposer *transposer);
    virtual ~TransposeFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Setter for the transposition
     */
    void SetTransposition(const std::string &transposition) { m_transposition = transposition; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitHarm(Harm *harm) override;
    FunctorCode VisitKeySig(KeySig *keySig) override;
    FunctorCode VisitMdiv(Mdiv *mdiv) override;
    FunctorCode VisitNote(Note *note) override;
    FunctorCode VisitRest(Rest *rest) override;
    FunctorCode VisitScore(Score *score) override;
    FunctorCode VisitStaffDef(StaffDef *staffDef) override;
 
protected:
    /*
     * Retrieve corresponding elements
     */
    const KeySig *GetKeySigForStaffDef(const StaffDef *staffDef) const;
    int GetStaffNForKeySig(const KeySig *keySig) const;
 
private:
    //
public:
    //
protected:
    // The transposer
    Transposer *m_transposer;
    // The current KeySig for staffN (ScoreDef key signatures are mapped to -1)
    std::map<int, const KeySig *> m_keySigForStaffN;
 
private:
    // The transposition to be applied
    std::string m_transposition;
};
 
//----------------------------------------------------------------------------
// TransposeSelectedMdivFunctor
//----------------------------------------------------------------------------
 
class TransposeSelectedMdivFunctor : public TransposeFunctor {
public:
    TransposeSelectedMdivFunctor(Doc *doc, Transposer *transposer);
    virtual ~TransposeSelectedMdivFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return false; }
 
    /*
     * Setter for the selected Mdiv
     */
    void SetSelectedMdivID(const std::string &selectedID) { m_selectedMdivID = selectedID; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitMdiv(Mdiv *mdiv) override;
    FunctorCode VisitPageMilestone(PageMilestoneEnd *pageMilestoneEnd) override;
    FunctorCode VisitScore(Score *score) override;
    FunctorCode VisitSystem(System *system) override;
 
protected:
    //
private:
    //
public:
    //
private:
    // The mdiv selected for transposition
    std::string m_selectedMdivID;
    // The list of current (nested) mdivs
    std::list<std::string> m_currentMdivIDs;
};
 
//----------------------------------------------------------------------------
// TransposeToSoundingPitchFunctor
//----------------------------------------------------------------------------
 
class TransposeToSoundingPitchFunctor : public TransposeFunctor {
public:
    TransposeToSoundingPitchFunctor(Doc *doc, Transposer *transposer);
    virtual ~TransposeToSoundingPitchFunctor() = default;
 
    /*
     * Abstract base implementation
     */
    bool ImplementsEndInterface() const override { return true; }
 
    /*
     * Functor interface
     */
    FunctorCode VisitMdiv(Mdiv *mdiv) override;
    FunctorCode VisitScore(Score *score) override;
    FunctorCode VisitScoreDef(ScoreDef *scoreDef) override;
    FunctorCode VisitScoreDefEnd(ScoreDef *scoreDef) override;
    FunctorCode VisitStaff(Staff *staff) override;
    FunctorCode VisitStaffDef(StaffDef *staffDef) override;
 
protected:
    //
private:
    // Update the current transposition
    void UpdateTranspositionFromStaffN(const AttNInteger *staffN);
 
public:
    //
private:
    // The transposition interval for staffN
    std::map<int, int> m_transposeIntervalForStaffN;
};
 
} // namespace vrv
 
#endif // __VRV_TRANSPOSEFUNCTOR_H__