Types.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jan 19 14:11:26 CET 2004  Types.hpp

                        Types.hpp -  description
                           -------------------
    begin                : Mon January 19 2004
    copyright            : (C) 2004 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.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_CORELIB_TYPES_HPP
#define ORO_CORELIB_TYPES_HPP

#include <map>
#include <vector>
#include <string>
#include "DataSourceBase.hpp"
#include <boost/shared_ptr.hpp>
#include "AttributeBase.hpp"
#include "Logger.hpp"

namespace RTT
{

    class PropertyBase;
    class PropertyBag;
    class AttributeBase;
    class TransportPlugin;

    namespace detail {
        class TypeTransporter;
    }

    struct RTT_API TypeBuilder
    {
        virtual ~TypeBuilder();
        virtual DataSourceBase::shared_ptr build(const std::vector<DataSourceBase::shared_ptr>& args) const = 0;

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

    class RTT_API TypeInfo
    {
    protected:
        typedef std::vector<TypeBuilder*> Constructors;
        typedef std::vector<detail::TypeTransporter*> Transporters;
        Constructors constructors;
        Transporters transporters;
    public:
        virtual ~TypeInfo();
        virtual const std::string& getTypeName() const = 0;

        virtual AttributeBase* buildConstant(std::string name,DataSourceBase::shared_ptr, int sizehint) const;
        virtual AttributeBase* buildConstant(std::string name,DataSourceBase::shared_ptr) const = 0;
        virtual AttributeBase* buildVariable(std::string name,int sizehint) const;
        virtual AttributeBase* buildVariable(std::string name) const = 0;

        virtual DataSourceBase::shared_ptr construct(const std::vector<DataSourceBase::shared_ptr>& args) const;

        virtual DataSourceBase::shared_ptr convert(DataSourceBase::shared_ptr arg) const;

        virtual void addConstructor(TypeBuilder* tb);

        virtual AttributeBase* buildAlias(std::string name, DataSourceBase::shared_ptr b ) const = 0;

        virtual PropertyBase* buildProperty(const std::string& name, const std::string& desc, DataSourceBase::shared_ptr source = 0) const = 0;

        virtual AttributeBase* buildAttribute(std::string name, DataSourceBase::shared_ptr source = 0 ) const = 0;

        virtual DataSourceBase::shared_ptr buildValue() const = 0;
        virtual std::ostream& write(std::ostream& os, DataSourceBase::shared_ptr in ) const = 0;

        virtual std::istream& read(std::istream& os, DataSourceBase::shared_ptr out ) const = 0;

        virtual std::string toString( DataSourceBase::shared_ptr in ) const;

        virtual bool fromString( const std::string& value, DataSourceBase::shared_ptr out ) const;
        virtual bool decomposeType( DataSourceBase::shared_ptr source, PropertyBag& targetbag ) const = 0;

        virtual bool composeType( DataSourceBase::shared_ptr source, DataSourceBase::shared_ptr target) const = 0;
        bool addProtocol(int protocol_id, detail::TypeTransporter* tt);

        detail::TypeTransporter* getProtocol(int protocol_id) const;

        std::vector<int> getTransportNames() const;
        
    };

    class RTT_API TypeInfoRepository
    {
        TypeInfoRepository();
        typedef std::map<std::string, TypeInfo*> map_t;
        map_t data;

        typedef std::vector<TransportPlugin*> Transports;
        Transports transports;
    public:
        ~TypeInfoRepository();
        typedef boost::shared_ptr<TypeInfoRepository> shared_ptr;
        static shared_ptr Instance();
        TypeInfo* type( const std::string& name ) const;

        bool addType( TypeInfo* );

        std::vector<std::string> getTypes() const;

        void registerTransport( TransportPlugin* tr );

        void logTypeInfo() const;

    };

    TypeInfoRepository::shared_ptr types();
}

#endif