/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

/**
    @file ObjectListBase.h
    @brief Definition of the ObjectListBase class.

    The ObjectListBase is a double-linked list, used by Identifiers to store all objects of a given class.
    Newly created objects are added through the RegisterObject-macro in its constructor.
*/

#ifndef _ObjectListBase_H__
#define _ObjectListBase_H__

#include <set>

#include "CorePrereqs.h"

namespace orxonox
{
    // ###############################
    // ###  ObjectListBaseElement  ###
    // ###############################
    //! The list-element of the ObjectListBase
    class _CoreExport ObjectListBaseElement
    {
        public:
            /**
                @brief Constructor: Creates the list-element with an object.
                @param object The object to store
            */
            ObjectListBaseElement(OrxonoxClass* object) : object_(object), next_(0), prev_(0) {}

            OrxonoxClass* object_;              //!< The object
            ObjectListBaseElement* next_;       //!< The next element in the list
            ObjectListBaseElement* prev_;       //!< The previous element in the list
    };


    // ###############################
    // ###     ObjectListBase      ###
    // ###############################
    //! The ObjectListBase contains all objects of a given class.
    /**
        The ObjectListBase is used by Identifiers to store all objects of their given class.
        Use ObjectList<T> to get the list of all T's and Iterator<T> to iterate through them.
    */
    class _CoreExport ObjectListBase
    {
        friend class MetaObjectListElement;

        public:
            ObjectListBase(Identifier* identifier);
            ~ObjectListBase();

            ObjectListBaseElement* add(OrxonoxClass* object);

            /** @brief Returns a pointer to the first element in the list. @return The element */
            inline ObjectListBaseElement* begin() const { return this->first_; }
            /** @brief Returns a pointer to the element after the last element in the list. @return The element */
            inline ObjectListBaseElement* end() const { return 0; }
            /** @brief Returns a pointer to the last element in the list. @return The element */
            inline ObjectListBaseElement* rbegin() const { return this->last_; }
            /** @brief Returns a pointer to the element in front of the first element in the list. @return The element */
            inline ObjectListBaseElement* rend() const { return 0; }

            inline void registerIterator(IteratorBase* iterator)
                { this->iterators_.insert(this->iterators_.end(), iterator); }
            inline void unregisterIterator(IteratorBase* iterator)
                { this->iterators_.erase(iterator); }
            void notifyIterators(ObjectListBaseElement* element);

            inline Identifier* getIdentifier() const { return this->identifier_; }

        private:
            Identifier* identifier_;             //!< The Iterator owning this list
            ObjectListBaseElement* first_;       //!< The first element in the list
            ObjectListBaseElement* last_;        //!< The last element in the list
            std::set<IteratorBase*> iterators_;  //!< A list of iterators pointing on an element in this list
    };
}

#endif /* _ObjectListBase_H__ */