msrOah.h

/*
  MusicXML Library
  Copyright (C) Grame 2006-2013
 
  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
*/
 
#ifndef ___msrOah___
#define ___msrOah___
 
#include "msrBasicTypes.h"
 
#include "oahBasicTypes.h"
 
 
namespace MusicXML2
{
 
//______________________________________________________________________________
class msrRenamePartAtom : public oahValuedAtom
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<msrRenamePartAtom> create (
      string               shortName,
      string               longName,
      string               description,
      string               valueSpecification,
      string               variableName,
      map<string, string>& stringStringMapVariable);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrRenamePartAtom (
      string               shortName,
      string               longName,
      string               description,
      string               valueSpecification,
      string               variableName,
      map<string, string>& stringStringMapVariable);
 
    virtual ~msrRenamePartAtom ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    const map<string, string>&
                          getStringStringMapVariable ()
                              { return fStringStringMapVariable; }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    S_oahValuedAtom       handleOptionUnderName (
                            string   optionName,
                            ostream& os);
 
    void                  handleValue (
                            string   theString,
                            ostream& os);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asShortNamedOptionString () const;
    string                asActualLongNamedOptionString () const;
 
    void                  print (ostream& os) const;
 
    void                  printAtomOptionsValues (
                            ostream& os,
                            int      valueFieldWidth) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    map<string, string>&  fStringStringMapVariable;
};
typedef SMARTP<msrRenamePartAtom> S_msrRenamePartAtom;
EXP ostream& operator<< (ostream& os, const S_msrRenamePartAtom& elt);
 
//______________________________________________________________________________
class msrTransposePartAtom : public oahValuedAtom
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<msrTransposePartAtom> create (
      string             shortName,
      string             longName,
      string             description,
      string             valueSpecification,
      string             variableName,
      map<string, S_msrSemiTonesPitchAndOctave>&
                         stringMsrSemiTonesPitchAndOctaveVariable);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrTransposePartAtom (
      string             shortName,
      string             longName,
      string             description,
      string             valueSpecification,
      string             variableName,
      map<string, S_msrSemiTonesPitchAndOctave>&
                         stringMsrSemiTonesPitchAndOctaveVariable);
 
    virtual ~msrTransposePartAtom ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    void                  setStringMsrSemiTonesPitchAndOctaveVariable (
                            string  partName,
                            S_msrSemiTonesPitchAndOctave
                                    semiTonesPitchAndOctave)
                              {
                                fStringMsrSemiTonesPitchAndOctaveVariable [
                                  partName
                                ] =
                                  semiTonesPitchAndOctave;
                              }
 
    const map<string, S_msrSemiTonesPitchAndOctave>&
                          getStringMsrSemiTonesPitchAndOctaveVariable ()
                              {
                                return
                                  fStringMsrSemiTonesPitchAndOctaveVariable;
                              }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    S_oahValuedAtom       handleOptionUnderName (
                            string   optionName,
                            ostream& os);
 
    void                  handleValue (
                            string   theString,
                            ostream& os);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asShortNamedOptionString () const;
    string                asActualLongNamedOptionString () const;
 
    void                  print (ostream& os) const;
 
    void                  printAtomOptionsValues (
                            ostream& os,
                            int      valueFieldWidth) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    map<string, S_msrSemiTonesPitchAndOctave>&
                          fStringMsrSemiTonesPitchAndOctaveVariable;
};
typedef SMARTP<msrTransposePartAtom> S_msrTransposePartAtom;
EXP ostream& operator<< (ostream& os, const S_msrTransposePartAtom& elt);
 
//______________________________________________________________________________
class msrOmitPartAtom : public oahValuedAtom
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<msrOmitPartAtom> create (
      string       shortName,
      string       longName,
      string       description,
      string       valueSpecification,
      string       variableName,
      set<string>& stringSetVariable);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrOmitPartAtom (
      string       shortName,
      string       longName,
      string       description,
      string       valueSpecification,
      string       variableName,
      set<string>& stringSetVariable);
 
    virtual ~msrOmitPartAtom ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    void                  setStringSetVariable (
                            string  partName)
                              { fStringSetVariable.insert (partName); }
 
    const set<string>&    getStringSetVariable ()
                              { return fStringSetVariable; }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    S_oahValuedAtom       handleOptionUnderName (
                            string   optionName,
                            ostream& os);
 
    void                  handleValue (
                            string   theString,
                            ostream& os);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asShortNamedOptionString () const;
    string                asActualLongNamedOptionString () const;
 
    void                  print (ostream& os) const;
 
    void                  printAtomOptionsValues (
                            ostream& os,
                            int      valueFieldWidth) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    set<string>&          fStringSetVariable;
};
typedef SMARTP<msrOmitPartAtom> S_msrOmitPartAtom;
EXP ostream& operator<< (ostream& os, const S_msrOmitPartAtom& elt);
 
//______________________________________________________________________________
class msrKeepPartAtom : public oahValuedAtom
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<msrKeepPartAtom> create (
      string       shortName,
      string       longName,
      string       description,
      string       valueSpecification,
      string       variableName,
      set<string>& stringSetVariable);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrKeepPartAtom (
      string       shortName,
      string       longName,
      string       description,
      string       valueSpecification,
      string       variableName,
      set<string>& stringSetVariable);
 
    virtual ~msrKeepPartAtom ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    void                  setStringSetVariable (
                            string  partName)
                              { fStringSetVariable.insert (partName); }
 
    const set<string>&    getStringSetVariable ()
                              { return fStringSetVariable; }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    S_oahValuedAtom       handleOptionUnderName (
                            string   optionName,
                            ostream& os);
 
    void                  handleValue (
                            string   theString,
                            ostream& os);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asShortNamedOptionString () const;
    string                asActualLongNamedOptionString () const;
 
    void                  print (ostream& os) const;
 
    void                  printAtomOptionsValues (
                            ostream& os,
                            int      valueFieldWidth) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    set<string>&          fStringSetVariable;
};
typedef SMARTP<msrKeepPartAtom> S_msrKeepPartAtom;
EXP ostream& operator<< (ostream& os, const S_msrKeepPartAtom& elt);
 
//______________________________________________________________________________
class msrPitchesLanguageAtom : public oahValuedAtom
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<msrPitchesLanguageAtom> create (
      string             shortName,
      string             longName,
      string             description,
      string             valueSpecification,
      string             variableName,
      msrQuarterTonesPitchesLanguageKind&
                         msrMsrPitchesLanguageKindVariable);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrPitchesLanguageAtom (
      string             shortName,
      string             longName,
      string             description,
      string             valueSpecification,
      string             variableName,
      msrQuarterTonesPitchesLanguageKind&
                         msrMsrPitchesLanguageKindVariable);
 
    virtual ~msrPitchesLanguageAtom ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    void                  setMsrQuarterTonesPitchesLanguageKindVariable (
                            msrQuarterTonesPitchesLanguageKind value)
                              {
                                fMsrQuarterTonesPitchesLanguageKindVariable = value;
                              }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    S_oahValuedAtom       handleOptionUnderName (
                            string   optionName,
                            ostream& os);
 
    void                  handleValue (
                            string   theString,
                            ostream& os);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asShortNamedOptionString () const;
    string                asActualLongNamedOptionString () const;
 
    void                  print (ostream& os) const;
 
    void                  printAtomOptionsValues (
                            ostream& os,
                            int      valueFieldWidth) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    msrQuarterTonesPitchesLanguageKind&
                          fMsrQuarterTonesPitchesLanguageKindVariable;
};
typedef SMARTP<msrPitchesLanguageAtom> S_msrPitchesLanguageAtom;
EXP ostream& operator<< (ostream& os, const S_msrPitchesLanguageAtom& elt);
 
//______________________________________________________________________________
class msrOah : public oahGroup
{
  public:
 
    static SMARTP<msrOah> create (
      S_oahHandler handlerUpLink);
 
    SMARTP<msrOah>        createCloneWithDetailedTrace ();
 
  public:
 
    // initialisation
    // ------------------------------------------------------
 
    void                  initializeMsrOah (
                            bool boolOptionsInitialValue);
 
  public:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    msrOah (
      S_oahHandler handlerUpLink);
 
    virtual ~msrOah ();
 
    // set and get
    // ------------------------------------------------------
 
    bool                  setMsrQuarterTonesPitchesLanguage (
                            string language);
 
  public:
 
    // quiet mode
    // ------------------------------------------------------
 
    void                  enforceQuietness ();
 
  public:
 
    // consistency check
    // ------------------------------------------------------
 
    virtual void          checkOptionsConsistency ();
 
  public:
 
    // public services
    // ------------------------------------------------------
 
  private:
 
    // private services
    // ------------------------------------------------------
 
#ifdef TRACE_OAH
    void                  initializeMsrTraceOah (
                            bool boolOptionsInitialValue);
#endif
 
    void                  initializeMsrDisplayOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrLanguagesOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrPartsOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrStavesOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrVoicesOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrRepeatsOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrNotesOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrLyricsOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrHarmoniesOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrFiguredBassOptions (
                            bool boolOptionsInitialValue);
 
    void                  initializeMsrExitAfterSomePassesOptions (
                            bool boolOptionsInitialValue);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    void                  printMsrOahHelp ();
 
    void                  printMsrOahValues (int fieldWidth);
 
  public:
 
    // trace
    // --------------------------------------
 
    bool                  fTraceMsr;
 
    bool                  fTraceMsrVisitors;
 
    // display
    // --------------------------------------
 
    bool                  fDisplayPartGroups;
 
    bool                  fDisplayMsr;
    bool                  fDisplayMsrDetails;
 
    bool                  fDisplayMsrNames;
    bool                  fDisplayMsrSummary;
 
 
    // languages
    // --------------------------------------
 
    msrQuarterTonesPitchesLanguageKind
                          fMsrQuarterTonesPitchesLanguageKind;
 
    // parts
    // --------------------------------------
 
    map<string, string>   fPartsRenamingMap;
 
    map<string, S_msrSemiTonesPitchAndOctave>
                          fPartsTranspositionMap;
 
    set<string>           fPartsOmitIDSet;
    set<string>           fPartsKeepIDSet;
 
    set<string>           fPartsOmitNameSet;
    set<string>           fPartsKeepNameSet;
 
    // for checkOptionsConsistency()
    S_oahStringSetAtom    fOmitPartIDAtom;
    S_oahStringSetAtom    fKeepPartIDAtom;
 
    S_oahStringSetAtom    fOmitPartNameAtom;
    S_oahStringSetAtom    fKeepPartNameAtom;
 
 
    // staves
    // --------------------------------------
 
    bool                  fCreateSingleLineStavesAsRythmic;
 
 
    // voices
    // --------------------------------------
 
    bool                  fCreateVoicesStaffRelativeNumbers;
 
 
    // repeats
    // --------------------------------------
 
    bool                  fCreateImplicitInitialRepeatBarline;
 
 
    // notes
    // --------------------------------------
 
    bool                  fDelayRestsDynamics;
    bool                  fDelayRestsWords; // JMI
    bool                  fDelayRestsBeams; // JMI
    bool                  fDelayRestsSlurs; // JMI
    bool                  fDelayRestsLigatures; // JMI
    bool                  fDelayRestsPedals; // JMI
    bool                  fDelayRestsSlashes; // JMI
    bool                  fDelayRestsWedges; // JMI
 
    bool                  fSlashAllGraceNotes;
    bool                  fSlurAllGraceNotes;
 
    // articulations
    // --------------------------------------
 
    bool                  fOmitArticulations;
 
 
    // ornaments
    // --------------------------------------
 
 
    bool                  fOmitOrnaments;
 
    // words
    // --------------------------------------
 
    bool                  fOmitWords;
 
    // ties
    // --------------------------------------
 
    bool                  fOmitTies;
 
    // dynamics
    // --------------------------------------
 
    bool                  fOmitDynamics;
 
    // slurs
    // --------------------------------------
 
    bool                  fOmitSlurs;
 
    // wedges
    // --------------------------------------
 
    bool                  fOmitWedges;
 
    // lyrics
    // --------------------------------------
 
    bool                  fAddStanzasNumbers; // LPSR ??? JMI
 
    bool                  fOmitLyrics;
 
 
    // harmonies
    // --------------------------------------
 
    bool                  fShowHarmonyVoices;
 
    bool                  fOmitHarmonies;
 
 
    // figured bass
    // --------------------------------------
 
    bool                  fShowFiguredBassVoices;
 
    bool                  fOmitFiguredBasses;
 
 
    // exit after some passes
    // --------------------------------------
 
    bool                  fExit2a;
    bool                  fExit2b;
};
typedef SMARTP<msrOah> S_msrOah;
EXP ostream& operator<< (ostream& os, const S_msrOah& elt);
 
EXP extern S_msrOah gMsrOah;
EXP extern S_msrOah gMsrOahUserChoices;
EXP extern S_msrOah gMsrOahWithDetailedTrace;
 
//______________________________________________________________________________
void initializeMsrOahHandling (
  S_oahHandler handler);
 
 
}
 
 
#endif