xml2brlManPageOah.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 ___xml2brlManPageOah___
#define ___xml2brlManPageOah___
 
#include "xml2brlOah2ManPageGenerator.h"
 
 
namespace MusicXML2
{
 
//______________________________________________________________________________
class xml2brlManPageGenerateAtom : public oahAtom
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<xml2brlManPageGenerateAtom> create (
      string                 shortName,
      string                 longName,
      string                 description,
      S_oahVisitor           theOahVisitor);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    xml2brlManPageGenerateAtom (
      string                 shortName,
      string                 longName,
      string                 description,
      S_oahVisitor           theOahVisitor);
 
    virtual ~xml2brlManPageGenerateAtom ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
  public:
 
    // public services
    // ------------------------------------------------------
 
    S_oahValuedAtom       handleOptionUnderName (
                            string   optionName,
                            ostream& os);
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    void                  print (ostream& os) const;
 
    void                  printAtomOptionsValues (
                            ostream& os,
                            int      valueFieldWidth) const;
 
  private:
 
    // private services
    // ------------------------------------------------------
 
    void                  generateManPageData (ostream& os) const;
 
  private:
 
    // fields
    // --------------------------------------
 
    S_oahVisitor          fOahVisitor;
};
typedef SMARTP<xml2brlManPageGenerateAtom> S_xml2brlManPageGenerateAtom;
EXP ostream& operator<< (ostream& os, const S_xml2brlManPageGenerateAtom& elt);
 
//______________________________________________________________________________
class xml2brlManPageOah : public oahGroup
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<xml2brlManPageOah> create (
      S_oahHandler           handlerUpLink,
      S_oahVisitor theOah2ManPageGenerator);
 
    SMARTP<xml2brlManPageOah>        createCloneWithDetailedTrace ();
 
  public:
 
    // initialisation
    // ------------------------------------------------------
 
    void                  initializeXml2brlManPageOah (
                            bool boolOptionsInitialValue,
                            S_oahVisitor
                                 theOah2ManPageGenerator);
 
  public:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    xml2brlManPageOah (
      S_oahHandler           handlerUpLink,
      S_oahVisitor theOah2ManPageGenerator);
 
    virtual ~xml2brlManPageOah ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
  public:
 
    // quiet mode
    // ------------------------------------------------------
 
    void                  enforceQuietness ();
 
  public:
 
    // consistency check
    // ------------------------------------------------------
 
    virtual void          checkOptionsConsistency ();
 
  public:
 
    // public services
    // ------------------------------------------------------
 
  private:
 
    // private services
    // ------------------------------------------------------
 
    void                  initializeManPageGenerateOptions (
                            bool boolOptionsInitialValue,
                            S_oahVisitor
                                 theOah2ManPageGenerator);
 
#ifdef TRACE_OAH
    void                  initializeManPageTraceOah (
                            bool boolOptionsInitialValue);
#endif
 
  public:
 
    // visitors
    // ------------------------------------------------------
 
    virtual void          acceptIn  (basevisitor* v);
    virtual void          acceptOut (basevisitor* v);
 
    virtual void          browseData (basevisitor* v);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    void                  printManPageOahelp ();
 
    void                  printManPageOahValues (int fieldWidth);
 
  private:
 
    // fields
    // --------------------------------------
 
    S_oahVisitor
                          fOah2ManPageGenerator;
};
typedef SMARTP<xml2brlManPageOah> S_xml2brlManPageOah;
EXP ostream& operator<< (ostream& os, const S_xml2brlManPageOah& elt);
 
EXP extern S_xml2brlManPageOah gxml2brlManPageOah;
EXP extern S_xml2brlManPageOah gxml2brlManPageOahUserChoices;
EXP extern S_xml2brlManPageOah gxml2brlManPageOahWithDetailedTrace;
 
//______________________________________________________________________________
EXP  void initializeXml2brlManPageOahHandling (
  S_oahHandler           handler,
  S_oahVisitor theOah2ManPageGenerator);
 
 
}
 
 
#endif