keysig.h

 
// Name:        keysig.h
// Author:      Rodolfo Zitellini
// Created:     10/07/2012
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_KEYSIG_H__
#define __VRV_KEYSIG_H__
 
#include <optional>
 
//----------------------------------------------------------------------------
 
#include "atts_analytical.h"
#include "atts_shared.h"
#include "atts_visual.h"
#include "clef.h"
#include "layerelement.h"
 
namespace vrv {
 
class ScoreDefInterface;
 
//----------------------------------------------------------------------------
// KeyAccidInfo
//----------------------------------------------------------------------------
struct KeyAccidInfo {
    data_ACCIDENTAL_WRITTEN accid;
    data_PITCHNAME pname;
};
 
//----------------------------------------------------------------------------
// KeySig
//----------------------------------------------------------------------------
 
class KeySig : public LayerElement,
               public ObjectListInterface,
               public AttColor,
               public AttKeySigAnl,
               public AttKeySigLog,
               public AttKeySigVis,
               public AttPitch,
               public AttVisibility {
public:
    KeySig();
    virtual ~KeySig();
    Object *Clone() const override { return new KeySig(*this); }
    void Reset() override;
    std::string GetClassName() const override { return "keySig"; }
 
    bool HasToBeAligned() const override { return true; }
 
    bool IsScoreDefElement() const override { return (this->GetParent() && this->GetFirstAncestor(SCOREDEF)); }
 
    bool IsSupportedChild(ClassId classId) override;
 
    bool AddChildAdditionalCheck(Object *child) override;
 
    int GetAccidCount(bool fromAttribute = false) const;
 
    data_ACCIDENTAL_WRITTEN GetAccidType() const;
 
    bool HasNonAttribKeyAccidChildren() const;
    void GenerateKeyAccidAttribChildren();
 
    data_KEYSIGNATURE ConvertToSig() const;
 
    data_KEYSIGNATURE ConvertToWritten(int diatonic, int chromatic) const;
    data_KEYSIGNATURE ConvertFromWritten(int diatonic, int chromatic) const;
 
    void FillMap(MapOfOctavedPitchAccid &mapOfPitchAccid) const;
 
    int GetFifthsInt() const;
 
    Clef *GetDrawingClef();
    void ResetDrawingClef();
    void SetDrawingClef(Clef *clef);
 
    //----------------//
    // Static methods //
    //----------------//
 
    static data_PITCHNAME GetAccidPnameAt(data_ACCIDENTAL_WRITTEN alterationType, int pos);
    static int GetOctave(data_ACCIDENTAL_WRITTEN alterationType, data_PITCHNAME pitch, const Clef *clef);
    static int GetFifthsDelta(int diatonic, int chromatic);
 
    //----------//
    // Functors //
    //----------//
 
    FunctorCode Accept(Functor &functor) override;
    FunctorCode Accept(ConstFunctor &functor) const override;
    FunctorCode AcceptEnd(Functor &functor) override;
    FunctorCode AcceptEnd(ConstFunctor &functor) const override;
 
protected:
    void FilterList(ListOfConstObjects &childList) const override;
 
private:
    std::optional<KeyAccidInfo> GetKeyAccidInfoAt(int pos) const;
 
public:
    bool m_skipCancellation;
    data_ACCIDENTAL_WRITTEN m_drawingCancelAccidType;
    char m_drawingCancelAccidCount;
 
    //----------------//
    // Static members //
    //----------------//
 
    static const data_PITCHNAME s_pnameForFlats[];
    static const data_PITCHNAME s_pnameForSharps[];
 
private:
    std::optional<Clef> m_drawingClef;
 
    //----------------//
    // Static members //
    //----------------//
 
    static const int octave_map[2][9][7];
};
 
} // namespace vrv
 
#endif