source: code/trunk/src/libraries/core/command/FunctorPtr.h @ 11453

/*
 *   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
    @ingroup Command FunctorExecutor
    @brief Typedefs and definitions of FunctorPtr, FunctorMemberPtr, FunctorStaticPtr, and FunctorPointerPtr

    Instances of orxonox::Functor are usually managed by an std::shared_ptr. This ensures
    that Functors will be destroyed after usage. To make things easier, there's a typedef
    that defines FunctorPtr as std::shared_ptr<Functor>.

    Because there's not only orxonox::Functor, but also orxonox::FunctorStatic, and
    orxonox::FunctorMember, the shared pointers need to store them all and also reflect
    their hierarchy - FunctorStatic and FunctorMember should not be mixed, but both can
    be converted to Functor. This is achieved by using orxonox::SharedChildPtr.

    Because it's not possible to use a typedef for a template, we have to define the
    helper class FunctorMemberPtr<T> that makes it easier to use FunctorMember. The
    same is also done for FunctorPointerPtr<T>, which can be converted to both,
    FunctorMemberPtr<T> as well as FunctorPtr.
*/

#ifndef _FunctorPtr_H__
#define _FunctorPtr_H__

#include "core/CorePrereqs.h"
#include <memory>

namespace orxonox
{
    using FunctorPtr = std::shared_ptr<Functor>;
    template <class T>
    using FunctorMemberPtr = std::shared_ptr<FunctorMember<T>>;
    using FunctorStaticPtr = std::shared_ptr<FunctorMember<void>>;
    template <class F, class T>
    using FunctorPointerPtr = std::shared_ptr<FunctorPointer<F, T>>;
}

#endif /* _FunctorPtr_H__ */