Public API Reference

cstool/bitmasktostr.h

Go to the documentation of this file.

/*
    Copyright (C) 2005 by Jorrit Tyberghein
              (C) 2005 by Frank Richter

    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 __CS_CSTOOL_BITMASKTOSTR_H__
#define __CS_CSTOOL_BITMASKTOSTR_H__

#include "csutil/csstring.h"

class CS_CRYSTALSPACE_EXPORT csBitmaskToString
{
public:
  struct MaskNames
  {
    uint bits;
    const char* name;
  };
  CS_DECLARE_STATIC_CLASSVAR_REF(scratch, GetScratch, csString)
  static const char* GetStr (uint mask, const MaskNames* names)
  {
    if (mask == 0)
      return "0";
    
    GetScratch().Clear();
    while (names->bits != 0)
    {
      if (mask & names->bits)
      {
        GetScratch() <<  " | " << names->name;
        mask &= ~names->bits;
      }
      names++;
    }
    if (mask != 0)
    {
      GetScratch().AppendFmt (" | %#x", mask);
    }
    return GetScratch().GetData() + 3;
  }
};

#define CS_BITMASKTOSTR_MASK_TABLE_BEGIN(tableName)           \
  static const csBitmaskToString::MaskNames tableName[] = {

#define CS_BITMASKTOSTR_MASK_TABLE_DEFINE(def)                \
    {def, #def},
#define CS_BITMASKTOSTR_MASK_TABLE_END                        \
    {0, 0}                                                    \
  }

#endif // __CS_CSTOOL_BITMASKTOSTR_H__

---