ARAuto.h

#ifndef ARAuto_H
#define ARAuto_H
 
/*
  GUIDO Library
  Copyright (C) 2002  Holger Hoos, Juergen Kilian, Kai Renz
  Copyright (C) 2002-2017 Grame
 
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr
 
*/
 
#include "ARMTParameter.h"
 
class ARMusicalVoiceState;
 
 
/*@mkdoc
 
@group:Miscellaneous
 
@tagname:\auto
@tagalias:\set
@tagtype:P
@tagnotation:sets voice level global settings
@tagdesc
@tagend
 
@params:
@param:autoEndBar:boolean:automatic end bar:on:true
@param:endBar:boolean:variant for autoEndBar:on:true
 
@param:autoPageBreak:boolean:automatic page break:on:true
@param:pageBreak:boolean:variant for autoPageBreak:on:true
 
@param:autoSystemBreak:boolean:automatic system break:on:true
@param:systemBreak:boolean:variant for autoSystemBreak:on:true
 
@param:autoClefKeyMeterOrder:boolean:automatic reordering of clef, key and meter:on:true
@param:clefKeyMeterOrder:boolean:variant for autoClefKeyMeterOrder:on:true
 
@param:autoLyricsPos:boolean:automatic collision avoidance for \lyrics:off:true
@param:lyricsAutoPos:boolean:variant for autoLyricsPos:off:true
 
@param:autoInstrPos:boolean:automatic positionning for \instr:off:true
@param:instrAutoPos:boolean:variant for autoInstrPos:off:true
 
@param:autoIntensPos:boolean:automatic collision avoidance for \intens:off:true
@param:intensAutoPos:boolean:variant for autoIntensPos:off:true
 
@param:autoHideTiedAccidentals:boolean:hide all acidentals on tied notes:on:true
 
@param:harmonyPos:boolean:above or below (see [\harmony](../Text/#harmony)):*none*:true
@param:fingeringPos:boolean:above or below (see [\fingering](../Text/#fingering)):*none*:true
@param:fingeringSize:float:the fingering text size (see [\fingering](../Text/#fingering)):*none*:true
 
@param:resolveMultiVoiceCollisions:boolean:resolve collisions between notes on the same staff in a multi voice context:off:true
 
@paramdesc
Lyrics collision management can produce unexpected results or even create new collisions.
In this case, you should switch to manual layout using the 'dx' and 'dy' [common parameters](../../tagsparams#common-parameters).
 
See the [Jazz](@EXAMPLES/allthethings/) example.<br />
See the [Beethoven](@EXAMPLES/beethoven/) example.<br />
See the [Sonata](@EXAMPLES/cpebach/) example.
 
@paramend
 
*/
 
 
class ARAuto : public ARMTParameter
{
    public:
        friend class ARMusicalVoiceState;
 
        enum state    { kOff,kOn };
        enum position { kDefault, kAbove,kBelow };
 
                 ARAuto();
        virtual ~ARAuto() {}
 
        state getClefKeyMeterOrderState() const     { return fClefKeyMeterOrderState; }
        state getEndBarState() const                { return fEndBarState; }
        state getSystemBreakState() const           { return fSystemBreakState; }
        state getPageBreakState() const             { return fPageBreakState; }
        state getAutoLyricsPos() const              { return fLyricsAutoPos; }
        state getAutoInstrPos() const               { return fInstrAutoPos; }
        state getAutoIntensPos() const              { return fIntensAutoPos; }
        state getAutoHideTiedAccidentals() const    { return fAutoHideTiedAccidentals; }
        state getAutoMultiVoiceCollisions() const   { return fAutoMultiVoiceCollisions; }
 
        position getHarmonyPos() const              { return fHarmonyPos; }
        position getFingeringPos() const            { return fFingeringPos; }
        float    getFingeringSize() const           { return fFingeringSize; }
        bool     hasFingeringPos() const            { return fHasFingeringPos; }
        bool     hasFingeringSize() const           { return fHasFingeringSize; }
        bool     hasHarmonyPos() const              { return fHasHarmonyPos; }
        bool     hasMultiVoiceCollision() const     { return fHasMVoiceCollision; }
 
        virtual void setTagParameters (const TagParameterMap& params);
 
        virtual const char* getParamsStr() const    { return kARAutoParams; };
        virtual const char* getTagName () const     { return "ARAuto"; };
        virtual std::string getGMNName () const     { return "\\auto"; };
 
        virtual bool IsStateTag() const             { return true; }
 
    protected:
        state fEndBarState;
        state fPageBreakState;
        state fSystemBreakState;
        state fClefKeyMeterOrderState;
        state fLyricsAutoPos;
        state fInstrAutoPos;
        state fIntensAutoPos;
        state fAutoHideTiedAccidentals;
        state fAutoMultiVoiceCollisions;
    
        bool        fHasFingeringPos    = false;
        bool        fHasHarmonyPos      = false;
        bool        fHasFingeringSize   = false;
        bool        fHasMVoiceCollision = false;
        position    fFingeringPos;
        position    fHarmonyPos;
        float       fFingeringSize;
};
 
#endif