metaobject.hpp

Go to the documentation of this file.

#pragma once
/*
**  Copyright (C) 2013 Aldebaran Robotics
**  See COPYING for the license
*/

#ifndef _QI_TYPE_METAOBJECT_HPP_
#define _QI_TYPE_METAOBJECT_HPP_

#include <qi/type/metamethod.hpp>
#include <qi/type/metasignal.hpp>
#include <qi/type/metaproperty.hpp>

#ifdef _MSC_VER
#  pragma warning( push )
#  pragma warning( disable: 4251 )
#endif

namespace qi {

  class MetaObjectPrivate;
  class GenericFunctionParameters;

  class QI_API MetaObject  {
  public:
    MetaObject();
    MetaObject(const MetaObject &other);
    MetaObject& operator=(const MetaObject &other);
    ~MetaObject();

    int methodId(const std::string &nameWithSignature) const;
    int signalId(const std::string &name) const;
    int propertyId(const std::string& name) const;

    using MethodMap = std::map<unsigned int, MetaMethod>;
    MethodMap methodMap() const;

    //not called signals because it conflict with Qt keywords :S
    using SignalMap = std::map<unsigned int, MetaSignal>;
    SignalMap signalMap() const;

    using PropertyMap = std::map<unsigned int, MetaProperty>;
    PropertyMap propertyMap() const;

    MetaMethod*       method(unsigned int id);
    const MetaMethod* method(unsigned int id) const;

    MetaSignal*       signal(unsigned int id);
    const MetaSignal* signal(unsigned int id) const;
    const MetaSignal* signal(const std::string &name) const;

    MetaProperty*       property(unsigned int id);
    const MetaProperty* property(unsigned int id) const;

    int findMethod(const std::string& nameWithOptionalSignature, const GenericFunctionParameters& args, bool* canCache=0) const;
    std::vector<MetaMethod> findMethod(const std::string &name) const;
    using CompatibleMethod = std::pair<MetaMethod, float>;
    std::vector<CompatibleMethod> findCompatibleMethod(const std::string &nameOrSignature) const;

    static bool isPrivateMember(const std::string &name, unsigned int uid);

    static qi::MetaObject merge(const qi::MetaObject &source, const qi::MetaObject &dest);

    std::string description() const;

    MetaObjectPrivate   *_p;
    MetaObject(const MethodMap& methodMap, const SignalMap& signalMap,
      const PropertyMap& propertyMap, const std::string& description);
  };

  bool QI_API operator < (const MetaObject& a, const MetaObject& b);

  class MetaObjectBuilderPrivate;
  class QI_API MetaObjectBuilder {
  public:
    MetaObjectBuilder();

    void setDescription(const std::string& desc);
    unsigned int addMethod(const qi::Signature &sigret,
                           const std::string &name,
                           const qi::Signature &signature,
                           int id = -1);
    unsigned int addMethod(MetaMethodBuilder& builder, int id = -1);
    unsigned int addSignal(const std::string &name, const qi::Signature& sig, int id = -1);
    unsigned int addProperty(const std::string& name, const qi::Signature& sig, int id = -1);
    qi::MetaObject metaObject();

  private:
    // C4251
    boost::shared_ptr<MetaObjectBuilderPrivate> _p;
  };

  namespace detail {
    QI_API void printMetaObject(std::ostream &stream, const qi::MetaObject &metaObject, bool color=true, bool showHidden=false, bool showDoc=false, bool raw=false, bool parseable=false);
  }

}


#ifdef _MSC_VER
#  pragma warning( pop )
#endif

#endif  // _QITYPE_METAOBJECT_HPP_