ChannelPromoteByTypenameRegistration.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_CHANNEL_PROMOTE_BY_TYPENAME_REGISTRATION_H_
#define _MIRA_CHANNEL_PROMOTE_BY_TYPENAME_REGISTRATION_H_

#include <utils/UniqueIdentifier.h>

#include <fw/Framework.h>
#include <fw/ChannelPromoteByTypename.h>

namespace mira {



namespace detail {


template <typename PromoteTo, typename T>
struct PromoteHelperCheckFundamental
{
    static void promote(ConcreteChannel<void>* channel)
    {
        // if T is fundamental, promote() is a no-op (there cannot be a channel of type PromoteTo!)
        if constexpr(!boost::is_fundamental<T>::value)
            channel_cast<PromoteTo>(channel);
    }
};

template <typename PromoteTo>
struct PromoteHelper
{
    static void promote(ConcreteChannel<void>* channel)
    {
        channel_cast<PromoteTo>(channel);
    }
};

template <typename T>
struct PromoteHelper<boost::shared_ptr<T>>
    : public PromoteHelperCheckFundamental<boost::shared_ptr<T>, T> {};

template <typename T>
struct PromoteHelper<std::vector<boost::shared_ptr<T>>>
    : public PromoteHelperCheckFundamental<std::vector<boost::shared_ptr<T>>, T> {};


}

#define COMMA ,

template <typename PromoteTo, typename ExtraDiscriminator>
class TypedChannelPromoter : public TypedChannelPromoterBase
{
    MIRA_META_OBJECT(TypedChannelPromoter<PromoteTo COMMA ExtraDiscriminator>,
                     ("PromoteTo", typeName() ) )
public:
    void promote(ConcreteChannel<void>* channel) const
    {
        detail::PromoteHelper<PromoteTo>::promote(channel);
    }

    static std::string typeName()
    {
        return mira::typeName<PromoteTo>();
    };
};

#undef COMMA

#ifdef MIRA_DISABLE_CHANNELPROMOTERS
    // #define macro empty to entirely disable registration
    #define MIRA_REGISTER_CHANNELTYPE(channeltype)
#else
    #ifndef MIRA_UNIQUE_IDENTIFIER_ENABLED
        #pragma message("UniqueIdentifier not enabled. "                      \
                        "MIRA_REGISTER_CHANNELTYPE disabled.")
        #define MIRA_REGISTER_CHANNELTYPE(channeltype)
    #else
        // semi-unique identifier __project_path_to_file_line__
        #define MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME                         \
            MIRA_FILE_LINE_IDENTIFIER

        // Define a unique class and use it as extra template parameter
        // for the promoter specialization to register.
        // Using the source file name and line as part of the resulting type name
        // gives the bonus advantage that its origin can easily be found in the code.
        #define MIRA_REGISTER_CHANNELTYPE(channeltype)                        \
        namespace MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME {                     \
            class plain{};                                                    \
        }                                                                     \
        MIRA_VARTEMPLATE_CLASS_REGISTER(                                      \
            (mira), TypedChannelPromoter, 2,                                  \
            (channeltype,                                                     \
             MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME::plain),                   \
            mira::TypedChannelPromoterBase)                                   \
                                                                              \
        namespace MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME {                     \
            class boost_optional{};                                           \
        }                                                                     \
        MIRA_VARTEMPLATE_CLASS_REGISTER(                                      \
            (mira), TypedChannelPromoter, 2,                                  \
            (boost::optional<channeltype>,                                    \
             MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME::boost_optional),          \
            mira::TypedChannelPromoterBase)                                   \
                                                                              \
        namespace MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME {                     \
            class boost_shared_ptr{};                                         \
        }                                                                     \
        MIRA_VARTEMPLATE_CLASS_REGISTER(                                      \
            (mira), TypedChannelPromoter, 2,                                  \
            (boost::shared_ptr<channeltype>,                                  \
             MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME::boost_shared_ptr),        \
            mira::TypedChannelPromoterBase)                                   \
                                                                              \
        namespace MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME {                     \
            class std_vector{};                                               \
        }                                                                     \
        MIRA_VARTEMPLATE_CLASS_REGISTER(                                      \
            (mira), TypedChannelPromoter, 2,                                  \
            (std::vector<channeltype>,                                        \
             MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME::std_vector),              \
            mira::TypedChannelPromoterBase)                                   \
                                                                              \
        namespace MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME {                     \
            class std_vector_boost_optional{};                                \
        }                                                                     \
        MIRA_VARTEMPLATE_CLASS_REGISTER(                                      \
            (mira), TypedChannelPromoter, 2,                                  \
            (std::vector<boost::optional<channeltype>>,                       \
             MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME::std_vector_boost_optional),\
            mira::TypedChannelPromoterBase)                                   \
                                                                              \
        namespace MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME {                     \
            class std_vector_boost_shared_ptr{};                              \
        }                                                                     \
        MIRA_VARTEMPLATE_CLASS_REGISTER(                                      \
            (mira), TypedChannelPromoter, 2,                                  \
            (std::vector<boost::shared_ptr<channeltype>>,                     \
             MIRA_REGISTER_CHANNELTYPE_UNIQUE_NAME::std_vector_boost_shared_ptr),\
            mira::TypedChannelPromoterBase)
    #endif
#endif



}

#endif