source: orxonox.OLD/trunk/src/lib/lang/new_object_list.h @ 9663

/*!
 * @file new_object_list.h
 * @brief Definition of a dynamically allocating ClassID
 *
 */

#ifndef _NEW_OBJECT_LIST_H
#define _NEW_OBJECT_LIST_H

#include "type_info.h"
#include <set>
#include <list>
#include <string>


#define NewObjectListDeclaration(ClassName) \
   static NewObjectList<ClassName> objectList

#define NewObjectListDefinition(ClassName) \
   NewObjectList<ClassName> ClassName::objectList(#ClassName)

class NewObjectListBase
{
public:
  int id() const { return _id; };
  const std::string& name() const { return _name; };
  bool operator==(int id) const { return _id == id; };
  bool operator==(const std::string& name) const { return _name == name; };


  /// Comparing operators.
  bool compareName(const NewObjectListBase& more) { return this->_name < more.name(); };
  bool compareID(const NewObjectListBase& more) { return this->_id < more.id(); };


  static unsigned int                   classCount() { return _idCounter; };
  static const std::string&             IDToString(int classID);
  static int                            StringToID(const std::string& className);

  static const std::list<std::string>&  getClassNames();

protected:
  NewObjectListBase(const std::string& className);
  ~NewObjectListBase();

private:
  NewObjectListBase(const NewObjectListBase&);

  static bool classNameExists(const std::string& className);

private:
  int                           _id;
  std::string                   _name;

private:
  typedef std::set<NewObjectListBase*>  cList;

  static int                           _idCounter;      //!< A counter, that gives all classes a Unique ClassID. Access to this Variable is to be Thread-Safe.
  static cList*                        _classes;        //!< A Set of all the classes in existance.
  static std::list<std::string>        _classNames;     //!< A list of all the registered ClassNames.
};


/////////////////////////
//// TEMPLATISATION /////
/////////////////////////
//! Defines a ObjectsList handler for objects of type T.
/**
 * @note The Class must define the compare with const std::string& operator for this to work.
 */
template<class T> class NewObjectList : public NewObjectListBase
{
public:
  typedef std::list<T*>               list;
  typedef typename list::iterator     iterator;


public:
  NewObjectList(const std::string& name);
  ~NewObjectList();

  T*                      getObject(const std::string& name) const;
  inline const list&      objects() const { return _objects; };


private:
  //! the copy constructor will be hidden.
  NewObjectList(const NewObjectList& definer) {};

  list                _objects;
};

template <class T>
NewObjectList<T>::NewObjectList(const std::string& name)
    : NewObjectListBase(name)
{}

template <class T>
NewObjectList<T>::~NewObjectList()
{
  assert(_objects.empty());
}

template <class T>
T* NewObjectList<T>::getObject(const std::string& name) const
{
  iterator it = std::find(this->_objects.begin(), this->_objects.end(), name);
  if (it != this->_objects.end())
    return *it;
  else
    return NULL;
}

#endif /* _NEW_OBJECT_LIST_H */