GRPositionTag.h

#ifndef GRPositionTag_H
#define GRPositionTag_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 "GRTag.h"
#include "kf_ilist.h"
 
class GRSystem;
class GRNotationElement;
 
class GRSystemStartEndStruct
{
    public:
        enum setflag { LEFTMOST, RIGHTMOST, OPENLEFT, OPENRIGHT, NOTKNOWN };
            
                 GRSystemStartEndStruct() {}
        virtual ~GRSystemStartEndStruct();
 
        GRSystem *          grsystem        = 0;
        GRNotationElement * startElement    = 0;
        GRNotationElement * endElement      = 0;
 
        setflag startflag   = NOTKNOWN;
        setflag endflag     = NOTKNOWN;
 
        // these give the position in the associated lists ...
        // so that the tag later knows, where it's sub-parts start and end.
        GuidoPos startpos   = 0;
        GuidoPos endpos     = 0;
        void * p            = 0;
};
 
typedef KF_IPointerList<GRSystemStartEndStruct> SSEList;
 
// the position tag owns this list.
 
class GRPositionTag : public GRTag
{
    public:
        class GRSaveStruct 
        {
            public:
                    GRSaveStruct() {};
            virtual ~GRSaveStruct() {};
        };
 
                 GRPositionTag(const ARMusicalTag * armt = 0);
                 GRPositionTag(GuidoPos p_ep, const ARMusicalTag * armt = 0);
        virtual ~GRPositionTag() {}
 
 
        virtual void ResumeTag(GRStaff * grstaff, GuidoPos assocpos);
        virtual void BreakTag(GRStaff * grstaff, GuidoPos & assocpos);
        virtual void StaffBegin(GRStaff  * grstaff = 0);
        virtual void StaffFinished(GRStaff * grstaff = 0);
        virtual void FinishPTag (GRStaff *)     {}
        virtual void RangeEnd(GRStaff * grstaff = 0);
        virtual bool DeleteStaff(GRStaff * grstaff);
 
        void changeCurrentSystem(GRSystem * psystem);
        void DeleteAllSSEs();
 
        GuidoPos getEndPos() const { return fEndPos; }
 
        GRSystemStartEndStruct * getSystemStartEndStruct(const GRSystem * grsystem) const;
        void                     addSystemStartEndStruct(GRSystemStartEndStruct * sse) { mStartEndList.AddTail(sse); }
 
    protected:
 
        virtual void setStartElement(const GRStaff * grstaff,   GRNotationElement * n_element);
        virtual void setEndElement(const GRStaff * grstaff, GRNotationElement * n_element);
        virtual void addAssociation(GRNotationElement * grnot);
        virtual void removeAssociation(GRNotationElement * grnot);
 
        virtual GRPositionTag::GRSaveStruct * getNewGRSaveStruct()  { return new GRSaveStruct; }
 
        SSEList mStartEndList;  // the Range tag Start-End List
 
        GRSystemStartEndStruct::setflag lastendflag;
        GRNotationElement * lastendElement;
        GuidoPos lastendpos;
 
    private:
        GuidoPos fEndPos = nullptr;
 
};
 
 
#endif