ARMusicalVoiceState.h

#ifndef ARMusicalVoiceState_H
#define ARMusicalVoiceState_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 <typeinfo>

#include "TagList.h"		// is a typedef
#include "defines.h"		// for TYPE_TIMEPOSITION
#include "GUIDOTypes.h"		// for GuidoPos

class ARMusicalTag;
class ARPositionTag;
class ARMeter;
class ARDisplayDuration;
class ARBeamState;
class ARAuto;
class ARGrace;
class ARChordTag;

template <class T> class KF_IPointerList;
typedef KF_IPointerList<ARPositionTag> PositionTagList;

/** \brief This class manage the state of a voice. Here additional information for 
	voices will be stored (i.e..: Stemstate (Stemsup, down, auto).
 */
class ARMusicalVoiceState
{
	friend class ARMusic;
	friend class ARMusicalVoice;
	friend class ARVoiceManager;
	friend class GRVoiceManager;

	public:
				ARMusicalVoiceState();
				ARMusicalVoiceState(const ARMusicalVoiceState &vst);
				ARMusicalVoiceState & operator=(const ARMusicalVoiceState & vst);

		virtual ~ARMusicalVoiceState();

        ARMusicalTag * getCurStateTag	(const std::type_info & ti);
		ARMusicalTag * RemoveCurStateTag(const std::type_info & ti);

		void DeleteAddedAndRemovedPTags();
		
		const TagList * getCurTags() const					{ return curtags; }
		const TagList * getCurStateTags() const				{ return curstatetags; }
		const PositionTagList * getCurPositionTags() const	{ return curpositiontags; }

		void AddStateTag		(ARMusicalTag * ntag);
		void AddTag				(ARMusicalTag * ntag);
		void RemoveTag			(ARMusicalTag * ntag);
		void AddPositionTag		(ARPositionTag * ntag, int addtoaddedlist = 1);
		void RemovePositionTag	(ARPositionTag * ntag, int addtoremovedlist = 1);

		void DeleteAll();
	
		const PositionTagList * addedPTags() const		{ return addedpositiontags; }
		const PositionTagList * removedPTags() const	{ return removedpositiontags; }
		const PositionTagList * currentPTags() const	{ return curpositiontags; }
	
		const ARMeter *	curMeter() const				{ return curmeter; }
		const ARDisplayDuration * curDispDur() const	{ return fCurdispdur; }

	protected:
		// The timeposition of the last barline.
		TYPE_TIMEPOSITION curlastbartp;
		GuidoPos curlastbarpos;
		// ptagpos indicates the current position within the ptaglist.
		GuidoPos ptagpos;

		TYPE_TIMEPOSITION curtp;
		// Distinguish between Tags, that allow a range and those, who don't 

		TagList * curstatetags; // A list of Tags, that determine the State of
							// the voice (e.g. clef, key, meter, etc. )
							// All the tags, that have no range ...

		// the tags that are just tags in the musical voice, like e.g. ARText 
		// or ARFermata ... (the ones without ranges)
		TagList * curtags;

		GuidoPos vpos; // Position within the voice

		// now we save the current meter
		// which is actually also a state-tag -> this is handled so that autobeaming can be done elegantly
		ARMeter * curmeter;
		// the current displayduration (if set) ...
		ARDisplayDuration * fCurdispdur;

		// we also save the beamstate ... makes it more elegant for autobeaming ...
		ARBeamState * curbeamstate;
		ARAuto * curautostate;
		ARGrace * curgracetag;
		ARChordTag * curchordtag;

		ARMusicalVoiceState * chordState;
		ARMusicalVoiceState * prevchordState;

	private:
		// these describe those position tags that have been Added in the last
		// operation on the Voice with the given state.
		PositionTagList * addedpositiontags;

		// this list holds all the position tags that have been removed in the last
		// operation on the Voice with the state.
		PositionTagList * removedpositiontags;

		// this list holds all the position tags that are currently active.
		PositionTagList * curpositiontags;
	
};

#endif