BitfieldHelper.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_BITFIELD_HELPER_H_INCLUDED
#define ICL_CORE_BITFIELD_HELPER_H_INCLUDED

#include "icl_core/TemplateHelper.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {

template <typename T>
void setBits(int bits, typename ConvertToRef<T>::ToRef bitfield)
{
  bitfield = T(int(bitfield) | bits);
}

template <typename T>
void clearBits(int bits, typename ConvertToRef<T>::ToRef bitfield)
{
  bitfield = T(int(bitfield) & ~bits);
}

template <typename T>
bool isBitSet(int bit, typename ConvertToRef<T>::ToConstRef bitfield)
{
  return (bitfield & T(bit)) != 0;
}

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

template <typename T>
void SetBits(int bits, typename ConvertToRef<T>::ToRef bitfield) ICL_CORE_GCC_DEPRECATE_STYLE;
template <typename T>
ICL_CORE_VC_DEPRECATE_STYLE void SetBits(int bits, typename ConvertToRef<T>::ToRef bitfield)
{
  setBits(bits, bitfield);bitfield = T(int(bitfield) | bits);
}

template <typename T>
void ClearBits(int bits, typename ConvertToRef<T>::ToRef bitfield) ICL_CORE_GCC_DEPRECATE_STYLE;
template <typename T>
ICL_CORE_VC_DEPRECATE_STYLE void ClearBits(int bits, typename ConvertToRef<T>::ToRef bitfield)
{
  clearBits(bits, bitfield);
}

template <typename T>
bool IsBitSet(int bit, typename ConvertToRef<T>::ToConstRef bitfield) ICL_CORE_GCC_DEPRECATE_STYLE;
template <typename T>
ICL_CORE_VC_DEPRECATE_STYLE bool IsBitSet(int bit, typename ConvertToRef<T>::ToConstRef bitfield)
{
  return isBitSet(bit, bitfield);
}

#endif

}

#endif