bsrBrailleCodeGenerators.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 ___bsrBrailleGenerators___
#define ___bsrBrailleGenerators___
 
#include "bsrCellsLists.h"
 
 
namespace MusicXML2
{
 
//______________________________________________________________________________
enum bsrUTFKind {
    kUTF8, kUTF16 };
 
string bsrUTFKindAsString (
  bsrUTFKind UTFKind);
 
enum bsrByteOrderingKind {
    kByteOrderingNone,
    kByteOrderingBigEndian, kByteOrderingSmallEndian };
 
string bsrByteOrderingKindAsString (
  bsrByteOrderingKind byteOrderingKind);
 
//______________________________________________________________________________
// Bytes Encoding Marks (BOM)
const string
  kBOM_UTF_32_BigEndian =
    "\x00\x00\xFE\xFF", // UTF-32, big-endian
  kBOM_UTF_32_LittleEndian =
    "\xFF\xFE\x00\x00", // UTF-32, little-endian
  kBOM_UTF_16_BigEndian =
    "\xFE\xFF",         // UTF-16, big-endian
  kBOM_UTF_16_LittleEndian =
    "\xFF\xFE",         // UTF-16, little-endian
  kBOM_UTF_8 =
    "\xEF\xBB\xBF";     // UTF-8
 
//______________________________________________________________________________
class bsrBrailleGenerator : public smartable
{
  public:
 
    // creation
    // ------------------------------------------------------
 
/* JMI
    static SMARTP<bsrBrailleGenerator> create (
                          byteOrderingKind,
      ostream&            brailleOutputStream);
*/
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    bsrBrailleGenerator (
      ostream&            brailleOutputStream);
 
    virtual ~bsrBrailleGenerator ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
  public:
 
    // services
    // ------------------------------------------------------
 
    virtual void          generateCodeForBrailleCell (
                            bsrCellKind cellKind) = 0;
 
    void                  generateCodeForCellsList (
                            S_bsrCellsList cellsList);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asString () const;
 
    virtual void          print (ostream& os) const;
 
  protected:
 
    // fields
    // ------------------------------------------------------
 
    ostream&              fBrailleOutputStream;
};
typedef SMARTP<bsrBrailleGenerator> S_bsrBrailleGenerator;
EXP ostream& operator<< (ostream& os, const S_bsrBrailleGenerator& elt);
 
//______________________________________________________________________________
class bsrAsciiBrailleGenerator : public bsrBrailleGenerator
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<bsrAsciiBrailleGenerator> create (
      ostream& brailleOutputStream);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    bsrAsciiBrailleGenerator (
      ostream& brailleOutputStream);
 
    virtual ~bsrAsciiBrailleGenerator ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
  public:
 
    // services
    // ------------------------------------------------------
 
    virtual void          generateCodeForBrailleCell (
                            bsrCellKind cellKind);
 
    static void           writeTestData (ostream& os);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asString () const;
 
    virtual void          print (ostream& os) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
};
typedef SMARTP<bsrAsciiBrailleGenerator> S_bsrAsciiBrailleGenerator;
EXP ostream& operator<< (ostream& os, const S_bsrAsciiBrailleGenerator& elt);
 
//______________________________________________________________________________
class bsrUTF8BrailleGenerator : public bsrBrailleGenerator
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<bsrUTF8BrailleGenerator> create (
      bsrByteOrderingKind byteOrderingKind,
      ostream&            brailleOutputStream);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    bsrUTF8BrailleGenerator (
      bsrByteOrderingKind byteOrderingKind,
      ostream&            brailleOutputStream);
 
    virtual ~bsrUTF8BrailleGenerator ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    bsrByteOrderingKind   getByteOrderingKind () const
                              { return fByteOrderingKind; }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    virtual void          generateCodeForBrailleCell (
                            bsrCellKind cellKind);
 
    static void           writeTestData (ostream& os);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asString () const;
 
    virtual void          print (ostream& os) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    bsrByteOrderingKind   fByteOrderingKind;
};
typedef SMARTP<bsrUTF8BrailleGenerator> S_bsrUTF8BrailleGenerator;
EXP ostream& operator<< (ostream& os, const S_bsrUTF8BrailleGenerator& elt);
 
//______________________________________________________________________________
class bsrUTF16BigEndianBrailleGenerator : public bsrBrailleGenerator
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<bsrUTF16BigEndianBrailleGenerator> create (
      bsrByteOrderingKind byteOrderingKind,
      ostream&            brailleOutputStream);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    bsrUTF16BigEndianBrailleGenerator (
      bsrByteOrderingKind byteOrderingKind,
      ostream&            brailleOutputStream);
 
    virtual ~bsrUTF16BigEndianBrailleGenerator ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    bsrByteOrderingKind   getByteOrderingKind () const
                              { return fByteOrderingKind; }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    virtual void          generateCodeForBrailleCell (
                            bsrCellKind cellKind);
 
    static void           writeTestData (ostream& os);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asString () const;
 
    virtual void          print (ostream& os) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    bsrByteOrderingKind   fByteOrderingKind;
};
typedef SMARTP<bsrUTF16BigEndianBrailleGenerator> S_bsrUTF16BigEndianBrailleGenerator;
EXP ostream& operator<< (ostream& os, const S_bsrUTF16BigEndianBrailleGenerator& elt);
 
//______________________________________________________________________________
class bsrUTF16SmallEndianBrailleGenerator : public bsrBrailleGenerator
{
  public:
 
    // creation
    // ------------------------------------------------------
 
    static SMARTP<bsrUTF16SmallEndianBrailleGenerator> create (
      bsrByteOrderingKind byteOrderingKind,
      ostream&            brailleOutputStream);
 
  protected:
 
    // constructors/destructor
    // ------------------------------------------------------
 
    bsrUTF16SmallEndianBrailleGenerator (
      bsrByteOrderingKind byteOrderingKind,
      ostream&            brailleOutputStream);
 
    virtual ~bsrUTF16SmallEndianBrailleGenerator ();
 
  public:
 
    // set and get
    // ------------------------------------------------------
 
    bsrByteOrderingKind   getByteOrderingKind () const
                              { return fByteOrderingKind; }
 
  public:
 
    // services
    // ------------------------------------------------------
 
    virtual void          generateCodeForBrailleCell (
                            bsrCellKind cellKind);
 
    static void           writeTestData (ostream& os);
 
  public:
 
    // print
    // ------------------------------------------------------
 
    string                asString () const;
 
    virtual void          print (ostream& os) const;
 
  private:
 
    // fields
    // ------------------------------------------------------
 
    bsrByteOrderingKind   fByteOrderingKind;
};
typedef SMARTP<bsrUTF16SmallEndianBrailleGenerator> S_bsrUTF16SmallEndianBrailleGenerator;
EXP ostream& operator<< (ostream& os, const S_bsrUTF16SmallEndianBrailleGenerator& elt);
 
 
} // namespace MusicXML2
 
 
#endif