msrParts_MUT_DEP.h

/*
  This file is to be included only by msrMutualDependencies.h,
  to satisfy declarations mutual dependencies.
*/
 
//______________________________________________________________________________
class msrPart : public msrPartGroupElement
{
  public:
 
    // constants
    // ------------------------------------------------------
 
    #define K_PART_FIGURED_BASS_STAFF_NUMBER -219
    #define K_PART_FIGURED_BASS_VOICE_NUMBER -227
 
    // creation from MusicXML
    // ------------------------------------------------------
 
    static SMARTP<msrPart> create (
      int            inputLineNumber,
      string         partID,
      S_msrPartGroup partPartGroupUpLink);
 
    SMARTP<msrPart> createPartNewbornClone (
      S_msrPartGroup partGroupClone);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrPart (
      int            inputLineNumber,
      string         partID,
      S_msrPartGroup partPartGroupUpLink);
 
    virtual ~msrPart ();
 
  private:
 
    // initialization
    // ------------------------------------------------------
 
    void                  initializePart ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    // upLinks
 
    void                  setPartPartGroupUpLink (
                            S_msrPartGroup partGroup)
                              { fPartPartGroupUpLink = partGroup; }
 
    S_msrPartGroup        getPartPartGroupUpLink () const
                              { return fPartPartGroupUpLink; }
 
    // part absolute number
 
    int                   getPartAbsoluteNumber () const
                              { return fPartAbsoluteNumber; }
 
    // ID and name
 
    void                  setPartID (string partID)
                              { fPartID = partID; }
 
    string                getPartID () const
                              { return fPartID; }
 
    void                  setPartMsrName (string partMsrName);
 
    string                getPartMsrName () const
                              { return fPartMsrName; }
 
    void                  setPartName (string partName)
                              { fPartName = partName; }
 
    string                getPartName () const
                              { return fPartName; }
 
    void                  setPartNameDisplayText (
                            string partNameDisplayText)
                              {
                                fPartNameDisplayText =
                                  partNameDisplayText;
                              }
 
    string                getPartNameDisplayText () const
                              { return fPartNameDisplayText; }
 
    void                  setPartAbbreviation (
                            string partAbbreviation)
                              {
                                fPartAbbreviation =
                                  partAbbreviation;
                              }
 
    string                getPartAbbreviation () const
                              { return fPartAbbreviation; }
 
    void                  setPartAbbreviationDisplayText (
                            string partAbbreviationDisplayText)
                              {
                                fPartAbbreviationDisplayText =
                                  partAbbreviationDisplayText;
                              }
 
    string                getPartAbbreviationDisplayText () const
                              { return fPartAbbreviationDisplayText; }
 
    string                getPartCombinedName () const;
 
    void                  setPartInstrumentNamesMaxLengthes ();
 
    // measures
 
    void                  setPartNumberOfMeasures (
                            int partNumberOfMeasures)
                              {
                                fPartNumberOfMeasures =
                                  partNumberOfMeasures;
                              }
 
    const int             getPartNumberOfMeasures () const
                              { return fPartNumberOfMeasures; }
    // instrument name
 
    void                  setPartInstrumentName (
                            string partInstrumentName)
                              {
                                fPartInstrumentName =
                                  partInstrumentName;
                              }
 
    string                getPartInstrumentName () const
                              { return fPartInstrumentName; }
 
    void                  setPartInstrumentAbbreviation (
                            string partInstrumentAbbreviation)
                              {
                                fPartInstrumentAbbreviation =
                                  partInstrumentAbbreviation;
                              }
 
    string                getPartInstrumentAbbreviation () const
                              { return fPartInstrumentAbbreviation; }
 
    // figured bass staff and voice
 
    void                  setPartFiguredBassStaff (
                            S_msrStaff figuredBassStaff)
                              {
                                fPartFiguredBassStaff =
                                  figuredBassStaff;
                              }
 
    S_msrStaff            getPartFiguredBassStaff () const
                              { return fPartFiguredBassStaff; }
 
    void                  setPartFiguredBassVoice (
                            S_msrVoice figuredBassVoice)
                              {
                                fPartFiguredBassVoice =
                                  figuredBassVoice;
                              }
 
    S_msrVoice            getPartFiguredBassVoice () const
                              { return fPartFiguredBassVoice; }
 
    // staves map
 
    const map<int, S_msrStaff>&
                          getPartStavesMap ()
                              { return fPartStavesMap; }
 
    // staff position in measure
 
    void                  setPartCurrentPositionInMeasure (
                            int      inputLineNumber,
                            rational positionInMeasure);
 
    void                  incrementPartCurrentPositionInMeasure (
                            int      inputLineNumber,
                            rational duration);
    void                  decrementPartCurrentPositionInMeasure (
                            int      inputLineNumber,
                            rational duration);
 
    rational              getPartCurrentPositionInMeasure () const
                              { return fPartCurrentPositionInMeasure; }
 
    // services
    // ------------------------------------------------------
 
    void                  assignSequentialNumbersToRegularVoicesInPart (
                            int inputLineNumber);
 
    void                  addAVoiceToStavesThatHaveNone (
                            int inputLineNumber);
 
    // part name display
 
    void                  appendPartNameDisplayToPart (
                            S_msrPartNameDisplay partNameDisplay);
 
    // part abbreviation display
 
    void                  appendPartAbbreviationDisplayToPart (
                            S_msrPartAbbreviationDisplay partAbbreviationDisplay);
 
/* JMI
    // figured bass staff and voice
 
    void                  createPartFiguredBassStaffAndVoiceIfNotYetDone (
                            int inputLineNumber);
        */
 
    // measures
 
    void                  createMeasureAndAppendItToPart (
                            int    inputLineNumber,
                            string measureNumber,
                            msrMeasure::msrMeasureImplicitKind
                                   measureImplicitKind);
 
    void                  setNextMeasureNumberInPart (
                            int    inputLineNumber,
                            string nextMeasureNumber);
 
    // clef, key, time
 
    void                  appendClefToPart (S_msrClef clef);
 
    void                  appendKeyToPart (S_msrKey  key);
 
    void                  appendTimeToPart (S_msrTime time);
    void                  appendTimeToPartClone (S_msrTime time);
 
    // transpose
 
    void                  appendTransposeToPart (
                            S_msrTranspose transpose);
 
    // staff details
 
    void                  appendStaffDetailsToPart (
                            S_msrStaffDetails staffDetails);
 
    // tuplets JMI ???
 
    // barlines
 
    void                  appendBarlineToPart (S_msrBarline barline);
 
    // repeats
 
    void                  handleRepeatStartInPart (
                            int inputLineNumber);
 
    void                  handleRepeatEndInPart (
                            int    inputLineNumber,
                            string measureNumber,
                            int    repeatTimes);
 
    void                  handleRepeatEndingStartInPart (
                            int inputLineNumber);
 
    void                  handleRepeatEndingEndInPart (
                            int       inputLineNumber,
                            string    repeatEndingNumber, // may be "1, 2"
                            msrRepeatEnding::msrRepeatEndingKind
                                      repeatEndingKind);
 
    /* JMI ???
    void                  finalizeRepeatEndInPart (
                            int    inputLineNumber,
                            string measureNumber,
                            int    repeatTimes);
                            */
 
    void                  appendRepeatCloneToPart (
                            int         inputLineNumber,
                            S_msrRepeat repeatCLone);
 
    void                  appendRepeatEndingCloneToPart (
                            S_msrRepeatEnding repeatEndingCLone);
 
    void                  createRestMeasuresInPart (
                            int inputLineNumber,
                            int restMeasuresNumber);
 
    void                  appendPendingRestMeasuresToPart (
                            int inputLineNumber);
 
    void                  appendRestMeasuresCloneToPart (
                            int               inputLineNumber,
                            S_msrRestMeasures restMeasures);
 
    void                  createMeasuresRepeatFromItsFirstMeasuresInPart (
                            int inputLineNumber,
                            int measuresRepeatMeasuresNumber,
                            int measuresRepeatSlashesNumber);
 
    void                  appendPendingMeasuresRepeatToPart (
                            int inputLineNumber);
 
    void                  appendMeasuresRepeatCloneToPart (
                            int               inputLineNumber,
                            S_msrRestMeasures restMeasures);
 
    // staves
 
    S_msrStaff            addStaffToPartByItsNumber (
                            int                    inputLineNumber,
                            msrStaff::msrStaffKind staffKind,
                            int                    staffNumber);
 
    void                  addStaffToPartCloneByItsNumber (
                            S_msrStaff staff);
 
    S_msrStaff            fetchStaffFromPart (int staffNumber);
 
    // voices
 
    void                  removePartEmptyVoices ();
 
    // harmonies
 
    // JMI ???
 
    // frames
 
    // JMI ???
 
    // figured bass
 
    void                  appendFiguredBassToPart (
                            S_msrVoice      figuredBassSupplierVoice,
                           S_msrFiguredBass figuredBass);
 
    void                  appendFiguredBassToPartClone (
                            S_msrVoice       figuredBassSupplierVoice,
                            S_msrFiguredBass figuredBass);
 
    // scordaturas
 
    void                  appendScordaturaToPart (
                            S_msrScordatura scordatura);
 
    // accordion registration
 
    void                  appendAccordionRegistrationToPart (
                            S_msrAccordionRegistration
                              accordionRegistration);
 
    // harp pedals tuning
 
    void                  appendHarpPedalsTuningToPart (
                            S_msrHarpPedalsTuning
                              harpPedalsTuning);
 
    // work around LilyPond issue 34
 
    void                  addSkipGraceNotesGroupBeforeAheadOfVoicesClonesIfNeeded (
                            S_msrVoice           graceNotesGroupOriginVoice,
                            S_msrGraceNotesGroup skipGraceNotesGroup);
 
/*
    void                  appendSkipGraceNotesToVoicesClones ( // JMI ???
                            S_msrVoice      graceNotesOriginVoice,
                            S_msrGraceNotes skipGraceNotes);
 
                            */
 
    void                  handleBackupInPart (
                            int      inputLineNumber,
                            rational backupStepLength);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    virtual string        asString () const;
 
    virtual void          print (ostream& os) const;
 
    virtual void          printSummary (ostream& os);
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    // upLinks
 
    S_msrPartGroup        fPartPartGroupUpLink;
 
    // part ID and name
 
    string                fPartID; // native
 
    string                fPartMsrName;
                            // may be different than fPartID
                            // if renamed,
                            // coined in constructor
 
    string                fPartName; // from '<part-name/>'
    string                fPartNameDisplayText;
 
    string                fPartAbbreviation;
    string                fPartAbbreviationDisplayText;
 
    // part absolute number
 
    int                   fPartAbsoluteNumber;
 
    // part instrument names
 
    string                fPartInstrumentName;
    string                fPartInstrumentAbbreviation;
 
    // measures
 
    string                fPartCurrentMeasureNumber;
 
    int                   fPartNumberOfMeasures;
 
    // clef, key, time
 
    S_msrClef             fPartCurrentClef;
 
    S_msrKey              fPartCurrentKey;
 
    S_msrTime             fPartCurrentTime;
 
    // transpose
 
    S_msrTranspose        fPartCurrentTranspose;
 
    // figured bass
 
    S_msrStaff            fPartFiguredBassStaff;
    S_msrVoice            fPartFiguredBassVoice;
 
    // the registered staves map
 
    map<int, S_msrStaff>  fPartStavesMap;
 
    // counter
 
    static int            gPartsCounter;
 
    // rest measures
 
    bool                  fPartContainsRestMeasures;
 
  public:
 
    // public work services
    // ------------------------------------------------------
 
    // measure number
 
    void                  setPartCurrentMeasureNumber (
                            string measureNumber)
                              {
                                fPartCurrentMeasureNumber =
                                  measureNumber;
                              }
 
    const string          getPartCurrentMeasureNumber () const
                              { return fPartCurrentMeasureNumber; }
 
    // clef, key, time
 
    S_msrClef             getPartCurrentClef () const
                              { return fPartCurrentClef; }
 
    S_msrKey              getPartCurrentKey  () const
                              { return fPartCurrentKey; }
 
    void                  setPartCurrentTime (S_msrTime time)
                              { fPartCurrentTime = time; }
 
    S_msrTime             getPartCurrentTime () const
                              { return fPartCurrentTime; }
 
    // transpose
 
    S_msrTranspose        getPartCurrentTranspose () const
                              { return fPartCurrentTranspose; }
 
    // staff details
 
    S_msrStaffDetails     getCurrentPartStaffDetails () const
                              { return fCurrentPartStaffDetails; }
 
    // finalization
 
    void                  finalizeCurrentMeasureInPart (
                            int inputLineNumber);
 
    void                  finalizePart (
                            int inputLineNumber);
 
    void                  finalizePartClone (
                            int inputLineNumber);
 
  private:
 
    // private work services
    // ------------------------------------------------------
 
    // measure elements
 
  private:
 
    // work fields
    // ------------------------------------------------------
 
    // staff details
 
    S_msrStaffDetails     fCurrentPartStaffDetails;
 
    // position in measure
 
    rational              fPartCurrentPositionInMeasure;
};
typedef SMARTP<msrPart> S_msrPart;
EXP ostream& operator<< (ostream& os, const S_msrPart& elt);