TAPsFlag.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsFlag.hpp

Flag class (hpp file).

SUKITTI PUNAK   (07/01/2008)
******************************************************************************/
#ifndef TAPs_FLAG_HPP
#define TAPs_FLAG_HPP

#include "../Core/TAPsStdLib.hpp"

// ANSI compatible version
#include <cstdio>
#include <cstdarg>

BEGIN_NAMESPACE_TAPs__DS
//=============================================================================
namespace FLAG {
    template< 
        int Bits,
        int Type = Bits <= sizeof(char)*8 ? 1 : ( Bits <= sizeof(short)*8 ? 2 : ( Bits <= sizeof(int)*8 ? 3 : 4 ) )
    > struct BestFit;

    template< int Bits > struct BestFit< Bits, 1 >  { typedef unsigned char  Type; };
    template< int Bits > struct BestFit< Bits, 2 >  { typedef unsigned short Type; };
    template< int Bits > struct BestFit< Bits, 3 >  { typedef unsigned int   Type; };
    template< int Bits > struct BestFit< Bits, 4 >  { typedef unsigned int   Type; };
};
//=============================================================================

//=============================================================================
template <typename T, int Bits = sizeof(char)*8, 
    typename Holder = typename FLAG::BestFit<Bits>::Type >
class Flag {
public:
    // Member Functions -------------------------------------------------------
    friend std::ostream & operator<< ( std::ostream &output, Flag<T,Bits,Holder> const &obj )
    {
        output << obj.StrInfo();
        return output;
    }
    //-------------------------------------------------------------------------
    Flag ( T f1 = T(0) );
    Flag ( Holder flags );
    Flag ( Flag<T,Bits,Holder> const &flag );   
    ~Flag ();                                   
    //-------------------------------------------------------------------------
    virtual std::string StrInfo () const;
    //-------------------------------------------------------------------------
    inline Flag<T,Bits,Holder> & operator= ( Flag<T,Bits,Holder> const &flag );
    //-------------------------------------------------------------------------
    inline bool operator== ( Flag<T,Bits,Holder> const & flag ) const;
    inline bool operator!= ( Flag<T,Bits,Holder> const & flag ) const;
    inline bool operator<  ( Flag<T,Bits,Holder> const & flag ) const;
    inline bool operator>= ( Flag<T,Bits,Holder> const & flag ) const;
    inline bool operator>  ( Flag<T,Bits,Holder> const & flag ) const;
    inline bool operator<= ( Flag<T,Bits,Holder> const & flag ) const;
    //-------------------------------------------------------------------------
    inline Flag<T,Bits,Holder>   operator~  () const;   
    inline Flag<T,Bits,Holder>   operator&  ( Flag<T,Bits,Holder> const & flag ) const;
    inline Flag<T,Bits,Holder>   operator|  ( Flag<T,Bits,Holder> const & flag ) const;
    inline Flag<T,Bits,Holder> & operator&= ( Flag<T,Bits,Holder> const & flag );
    inline Flag<T,Bits,Holder> & operator|= ( Flag<T,Bits,Holder> const & flag );
    //-------------------------------------------------------------------------
    inline void ClearAll ();
    inline void SetAll ();
    inline void ClearFlagNumber ( int i );          
    inline void SetFlagNumber   ( int i );          
    inline void ClearFlag   ( T flag );
    inline void SetFlag     ( T flag );
    //-------------------------------------------------------------------------

    inline bool CheckFlagNumber ( int i ) const;
    
    // one flag, then the result is true if one flag or more is set.
    inline bool CheckFlag ( T flag ) const;

    inline unsigned int FlagsToUnsignedInt () const { return static_cast<unsigned int>( m_flags ); }

    inline bool IsCleared () const  { return static_cast<unsigned int>( m_flags ) == 0 ? true : false; }

    //-------------------------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================
protected:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
    Holder m_flags;     
//=============================================================================
private:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================
}; // END CLASS Flag
//=============================================================================
//-----------------------------------------------------------------------------
//=============================================================================
END_NAMESPACE_TAPs__DS
//-----------------------------------------------------------------------------
#include "TAPsFlag.cpp"
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----