TKey.h

/*

  MusicXML Library
  Copyright (C) 2003  Grame

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  Grame Research Laboratory, 9 rue du Garet, 69001 Lyon - France
  grame@grame.fr

*/

#ifndef __TKey__
#define __TKey__

#include "exports.h"

#include <string>

#include "bimap.h"
#include "TScoreVisitor.h"

namespace MusicXML 
{

class EXP TKey : public visitable, public smartable {
    
    public:
        enum { undefined=-1 };
        enum { major=1, minor, dorian, phrygian, lydian, mixolydian, aeolian, 
                ionian, locrian, last=locrian };

        EXP friend SMARTP<TKey> newKey();
        
        void setCancel(long cancel);
        void setFifths(long fifths);
        void setMode(long mode);

        long getCancel() const          { return fCancel; }
        long getFifths() const          { return fFifths; }
        long getMode() const            { return fMode; }

        virtual void accept(TScoreVisitor& visitor);
 
    static const string xmlmode (int d);
    static int  xmlmode (const string str);
   
    protected:
        TKey() : fCancel(0), fFifths(0), fMode(undefined) {}
        virtual ~TKey() {}

    private:
        long    fCancel;
        long    fFifths;
        long    fMode;

    static bimap<string, int> fMode2String;
    static int      fModeTbl[];
    static string   fModeStrings[];
};
typedef SMARTP<TKey> SKey;

} // namespace MusicXML


#endif

---