MetaEnum.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef __OpenKarto_MetaEnum_h__
#define __OpenKarto_MetaEnum_h__

#include <OpenKarto/MetaType.h>
#include <OpenKarto/MetaEnumHelper.h>
#include <OpenKarto/MetaEnumManager.h>
#include <OpenKarto/String.h>
#include <OpenKarto/Referenced.h>
#include <OpenKarto/List.h>

namespace karto
{




  struct EnumPair
  {
    kt_bool operator == (const EnumPair& rOther) const
    {
      return rOther.name == name && rOther.value == value;
    }

    karto::String name;

    kt_int64s value;
  };


  typedef List< EnumPair > EnumPairList;


  struct FindByName
  {
    FindByName(const karto::String& rName)
      : m_name(rName) 
    {

    }

    kt_bool operator()(const EnumPair& rOther) const
    {
      return rOther.name == m_name;
    }

    karto::String m_name;
  };


  struct FindByValue
  {
    FindByValue(kt_int64s value) 
      : m_value(value) 
    {
    }

    kt_bool operator()(const EnumPair& rOther) const
    {
      return rOther.value == m_value;
    }

    kt_int64s m_value;
  };


  struct MetaEnumPrivate;

  class KARTO_EXPORT MetaEnum : public Referenced
  {
  public:
    template <typename T>
    static MetaEnumHelper Register(const karto::String& rName)
    {
      MetaEnum& newEnum = MetaEnumManager::GetInstance().RegisterNew(rName, KartoTypeId<T>::Get(false));
      return MetaEnumHelper(newEnum);
    }

  public:
    const karto::String& GetName() const;

    kt_bool HasName(const karto::String& rName) const;

    kt_bool HasValue(kt_int64s value) const;

    const karto::String& GetName(kt_int64s value) const;
    
    kt_int64s GetValue(const karto::String& rName) const;

    kt_size_t GetSize() const;
    
    const EnumPair& GetPair(kt_size_t index) const;

  public:
    kt_bool operator==(const MetaEnum& rOther) const;

    kt_bool operator!=(const MetaEnum& rOther) const;

  protected:
    void AddEnumPair(const EnumPair& rPair);

  private:
    friend class MetaEnumHelper;
    friend class MetaEnumManager;

  private:
    MetaEnum(const karto::String& rName);
    ~MetaEnum();

  private:
    MetaEnumPrivate* m_pPrivate;
  };


}

#endif // __OpenKarto_MetaEnum_h__