TypeInfoName.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jun 26 13:25:56 CEST 2006  TypeInfoName.hpp

                        TypeInfoName.hpp -  description
                           -------------------
    begin                : Mon June 26 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@fmtc.be

 ***************************************************************************
 *   This library 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;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library 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 General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef ORO_TYPEINFO_NAME_HPP
#define ORO_TYPEINFO_NAME_HPP

#include "Types.hpp"
#include "../internal/DataSourceTypeInfo.hpp"
#include "../Logger.hpp"
#include "../rtt-config.h"

namespace RTT
{ namespace types {

    class RTT_API EmptyTypeInfo
        : public TypeInfo
    {
    protected:
        const std::string tname;
    public:
        EmptyTypeInfo(std::string name)
            : tname(name)
        {
        }

        using TypeInfo::buildConstant;
        using TypeInfo::buildVariable;

        bool installTypeInfoObject() {
            return true;
        }

        base::AttributeBase* buildConstant(std::string name,base::DataSourceBase::shared_ptr dsb) const
        {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build Constant of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        base::AttributeBase* buildVariable(std::string name) const
        {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build Variable of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        base::AttributeBase* buildAttribute(std::string name, base::DataSourceBase::shared_ptr in) const
        {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build Attribute of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        base::AttributeBase* buildAlias(std::string name, base::DataSourceBase::shared_ptr in ) const
        {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build Alias of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        base::DataSourceBase::shared_ptr buildActionAlias(base::ActionInterface* act, base::DataSourceBase::shared_ptr in ) const
        {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build ActionAlias of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        virtual const std::string& getTypeName() const { return tname; }

        virtual base::PropertyBase* buildProperty(const std::string& name, const std::string& desc, base::DataSourceBase::shared_ptr source = 0) const {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build Property of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        virtual base::DataSourceBase::shared_ptr buildValue() const {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build internal::ValueDataSource of "<<tname<<"."<<Logger::endl;
            return 0;
        }

        virtual base::DataSourceBase::shared_ptr buildReference(void*) const {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not build internal::ReferenceDataSource of "<<tname<<"."<<Logger::endl;
            return 0;
        }


        base::DataSourceBase::shared_ptr construct(const std::vector<base::DataSourceBase::shared_ptr>& ) const {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not construct value of "<<tname<<"."<<Logger::endl;
            return base::DataSourceBase::shared_ptr();
        }

        virtual base::DataSourceBase::shared_ptr getAssignable(base::DataSourceBase::shared_ptr arg) const {
            return base::DataSourceBase::shared_ptr();
        }

        virtual std::ostream& write( std::ostream& os, base::DataSourceBase::shared_ptr in ) const {
            Logger::In loc("TypeInfoName");
#ifdef OS_HAVE_STREAMS
                std::string output = std::string("(")+ in->getTypeName() +")";
                os << output;
#endif
            return os;
        }

        virtual std::istream& read( std::istream& is, base::DataSourceBase::shared_ptr out ) const {
            Logger::In loc("TypeInfoName");
            return is;
        }

        virtual bool isStreamable() const { return false; }

        virtual base::DataSourceBase::shared_ptr decomposeType( base::DataSourceBase::shared_ptr source ) const {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Debug << "Can not decompose "<<tname<<"."<<Logger::endl;
            return source;
        }

        virtual bool composeType( base::DataSourceBase::shared_ptr source, base::DataSourceBase::shared_ptr result) const {
            Logger::In loc("TypeInfoName");
            Logger::log() << Logger::Error << "Can not compose "<<tname<<"."<<Logger::endl;
            return false;
        }

        virtual const char * getTypeIdName() const { return 0; }
        virtual TypeInfo::TypeId getTypeId() const { return 0; }

        virtual base::InputPortInterface* inputPort(std::string const& name) const
        { return 0; }
        virtual base::OutputPortInterface* outputPort(std::string const& name) const
        { return 0; }
        virtual base::ChannelElementBase::shared_ptr buildDataStorage(ConnPolicy const& policy) const
        { return base::ChannelElementBase::shared_ptr(); }
        virtual base::ChannelElementBase::shared_ptr buildChannelOutput(base::InputPortInterface& port) const
        { return base::ChannelElementBase::shared_ptr(); }
        virtual base::ChannelElementBase::shared_ptr buildChannelInput(base::OutputPortInterface& port) const
        { return base::ChannelElementBase::shared_ptr(); }

    };

    template<typename T>
    struct TypeInfoName
        : public EmptyTypeInfo
    {
        TypeInfoName(std::string name)
            : EmptyTypeInfo(name)
        {
        }

        bool installTypeInfoObject() {
            Logger::In in("TypeInfoName");
            TypeInfo* orig = internal::DataSourceTypeInfo<T>::value_type_info::TypeInfoObject;
            if ( orig != 0) {
                std::string oname = orig->getTypeName();
                if ( oname != tname ) {
                    log(Info) << "TypeInfo for type '" << tname << "' already exists as '"
                              << oname
                              << "': I'll alias the original and install the new instance." << endlog();
                    this->migrateProtocols( orig );
                    Types()->aliasType( oname, this); // deletes orig !
                }
            } else {
                // check for type name conflict (ie "string" for "std::string" and "Foo::Bar"
                if ( Types()->type(tname) ) {
                    log(Error) << "You attemted to register type name "<< tname << " which is already "
                               << "in use for a different C++ type." <<endlog();
                    return false;
                }
            }
            // finally install it:
            internal::DataSourceTypeInfo<T>::value_type_info::TypeInfoObject = this;
            return true;
        }
    };

}}

#endif