Flags.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_Flags_hxx
#define __ccxx_Flags_hxx

#include <commonc++/Common.h++>
#include <commonc++/OutOfBoundsException.h++>

namespace ccxx {

template<typename T> class Flags
{
 public:

  Flags(const T& flags = 0);

  ~Flags();

  bool isSet(int index) const;

  void set(int index, bool on = true);

  bool anySet(const T& mask) const;

  bool allSet(const T& mask) const;

  bool operator[](int index) const;

  class BitRef;

  BitRef operator[](int index);

  void clear(int flag);

  void clear();

  operator T() const
  { return(_flags); }

  Flags& operator=(const T& flags);

  class BitRef
  {
   public:

    BitRef(Flags& flags, int index);
    BitRef& operator=(bool value);

   private:

    Flags& _flags;
    int _index;
  };
 private:

  T _flags;
};

#include <commonc++/FlagsImpl.h++>

} // namespace ccxx

#endif // __ccxx_Flags_hxx