src/core/bitfield.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU General Public License as        *
   7  *   published by the Free Software Foundation and appearing               *
   8  *   in the file LICENSE.GPL included in the packaging of this file.       *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   General Public License for more details.                              *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _core_bitfield_h
  18 #define _core_bitfield_h
  19
  20 #include <cstddef>
  21
  22 #include <tairon/core/string.h>
  23
  24 namespace Tairent
  25 {
  26
  27 namespace Core
  28 {
  29
  30 /** \brief BitField is an array of bits.
  31  */
  32 class BitField
  33 {
  34         public:
  35                 /** Constructs an empty BitField object of specific length.
  36                  *
  37                  * \param len Length of the bitfield (i.e. number of bits).
  38                  */
  39                 BitField(size_t len);
  40
  41                 /** Constructs a BitField object from a memory.
  42                  */
  43                 BitField(const char *mem, size_t len);
  44
  45                 /** Destroys the object.
  46                  */
  47                 ~BitField();
  48
  49                 /** Returns bit value at specific position.
  50                  *
  51                  * \param index Position of the bit.
  52                  */
  53                 bool getBit(size_t index);
  54
  55                 /** Returns pointer to the internal data structure.
  56                  */
  57                 const char *getData() {
  58                         return data;
  59                 };
  60
  61                 /** Returns length of this bitfield.
  62                  */
  63                 size_t getLength() {
  64                         return length;
  65                 };
  66
  67                 /** Returns number of bits that are not set.
  68                  */
  69                 size_t getRemaining() {
  70                         return remaining;
  71                 };
  72
  73                 /** Sets a bit at specific position.
  74                  *
  75                  * \param index Position of the bit.
  76                  * \param value Value of the new bit.
  77                  */
  78                 void setBit(size_t index, bool value = true);
  79
  80         private:
  81                 /** Bitfield.
  82                  */
  83                 char *data;
  84
  85                 /** Length of the bitfield.
  86                  */
  87                 size_t length;
  88
  89                 /** Number of bits that are still unset.
  90                  */
  91                 size_t remaining;
  92 };
  93
  94 }; // namespace Core
  95
  96 }; // namespace Tairent
  97
  98 #endif
  99
 100 // vim: ai sw=4 ts=4 noet fdm=marker