/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     util_FlagsEnum.h

  Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 16116 $
 *---------------------------------------------------------------------------*/

#ifndef NN_UTIL_UTIL_FLAGSENUM_H_
#define NN_UTIL_UTIL_FLAGSENUM_H_

#include <nn/types.h>
#include <nn/util/util_StaticAssert.h>

#ifdef __cplusplus

namespace nn { namespace util {

template <typename StorageT, typename EnumT>
class FlagsEnum
{
private:
    typedef FlagsEnum<StorageT, EnumT> Self;
    NN_STATIC_ASSERT(sizeof(EnumT) <= sizeof(StorageT));

private:
    StorageT        m_FlagsValue;

public:
    operator EnumT() const      { return Get(); }

    Self& operator =(bit32 v)   { Replace(v); return *this; }
    Self& operator =(int v)     { Replace(v); return *this; }

    void Replace(bit32 v)       { m_FlagsValue = static_cast<StorageT>(v); }
    void Replace(int v)         { m_FlagsValue = static_cast<StorageT>(v); }

    bit32 Get() const           { return m_FlagsValue; }

    void Set(EnumT e)           { m_FlagsValue |= e; }
    void IsSet(EnumT e) const   { return (m_FlagsValue & e) != 0; }
};

template <typename EnumT>
class FlagsEnum1 : public FlagsEnum<bit8, EnumT>
{
public:
    FlagsEnum1() : FlagsEnum<bit8, EnumT>() {}
    FlagsEnum1(EnumT e) : FlagsEnum<bit8, EnumT>(e) {}

    FlagsEnum1<EnumT>& operator =(bit32 v)   { this->Replace(v); return *this; }
    FlagsEnum1<EnumT>& operator =(int v)     { this->Replace(v); return *this; }
};

template <typename EnumT>
class FlagsEnum2 : public FlagsEnum<bit16, EnumT>
{
public:
    FlagsEnum2() : FlagsEnum<bit16, EnumT>() {}
    FlagsEnum2(EnumT e) : FlagsEnum<bit16, EnumT>(e) {}

    FlagsEnum2<EnumT>& operator =(bit32 v)   { this->Replace(v); return *this; }
    FlagsEnum2<EnumT>& operator =(int v)     { this->Replace(v); return *this; }
};

template <typename EnumT>
class FlagsEnum4 : public FlagsEnum<bit32, EnumT>
{
public:
    FlagsEnum4() : FlagsEnum<bit32, EnumT>() {}
    FlagsEnum4(EnumT e) : FlagsEnum<bit32, EnumT>(e) {}

    FlagsEnum4<EnumT>& operator =(bit32 v)   { this->Replace(v); return *this; }
    FlagsEnum4<EnumT>& operator =(int v)     { this->Replace(v); return *this; }
};

}}


#endif // __cplusplus

#endif /* NN_UTIL_UTIL_FLAGSENUM_H_ */