gz/plugin/Plugin.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
 
#ifndef GZ_PLUGIN_PLUGIN_HH_
#define GZ_PLUGIN_PLUGIN_HH_
 
#include <memory>
#include <map>
#include <string>
 
#include <gz/utilities/SuppressWarning.hh>
 
#include <gz/plugin/Export.hh>
#include <gz/plugin/Info.hh>
 
namespace ignition
{
  namespace plugin
  {
    // Forward declaration
    namespace detail {
      template <class, class> class ComposePlugin;
      template <class> class SelectSpecializers;
    }
    class EnablePluginFromThis;
    class WeakPluginPtr;
 
    class IGNITION_PLUGIN_VISIBLE Plugin
    {
      // -------------------- Public API ---------------------
 
      public: template <class Interface>
              Interface *QueryInterface();
 
      public: template <class Interface>
              const Interface *QueryInterface() const;
 
      public: template <class Interface>
              IGN_DEPRECATED(0.0)
              Interface *QueryInterface(const std::string &/*_interfaceName*/);
 
      public: template <class Interface>
              IGN_DEPRECATED(0.0)
              const Interface *QueryInterface(
                  const std::string &/*_interfaceName*/) const;
 
      public: template <class Interface>
              std::shared_ptr<Interface> QueryInterfaceSharedPtr();
 
      public: template <class Interface>
              std::shared_ptr<const Interface> QueryInterfaceSharedPtr() const;
 
      public: template <class Interface>
              IGN_DEPRECATED(0.0)
              std::shared_ptr<Interface> QueryInterfaceSharedPtr(
                  const std::string &/*_interfaceName*/);
 
      public: template <class Interface>
              IGN_DEPRECATED(0.0)
              std::shared_ptr<const Interface> QueryInterfaceSharedPtr(
                  const std::string &/*_interfaceName*/) const;
 
      public: template <class Interface>
              bool HasInterface() const;
 
      public: bool HasInterface(const std::string &_interfaceName,
                                const bool _demangled = true) const;
 
      public: const std::string *Name() const;
 
      // -------------------- Private API -----------------------
 
      template <class> friend class TemplatePluginPtr;
      template <class...> friend class SpecializedPlugin;
      template <class, class> friend class detail::ComposePlugin;
      template <class> friend class detail::SelectSpecializers;
      friend class EnablePluginFromThis;
      friend class WeakPluginPtr;
 
      protected: Plugin();
 
      private: void *PrivateQueryInterface(
                  const std::string &_interfaceName) const;
 
      private: void PrivateCopyPluginInstance(const Plugin &_other) const;
 
      private: void PrivateCopyPluginInstance(
                  const ConstInfoPtr &_info,
                  const std::shared_ptr<void> &_instancePtr) const;
 
      private: void PrivateCreatePluginInstance(
                  const ConstInfoPtr &_info,
                  const std::shared_ptr<void> &_dlHandlePtr) const;
 
      private: const std::shared_ptr<void> &PrivateGetInstancePtr() const;
 
      private: const ConstInfoPtr &PrivateGetInfoPtr() const;
 
      public: using InterfaceMap = std::map<std::string, void*>;
 
      private: InterfaceMap::iterator PrivateGetOrCreateIterator(
          const std::string &_interfaceName);
 
      class Implementation;
      IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: const std::unique_ptr<Implementation> dataPtr;
      IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
 
      public: virtual ~Plugin();
    };
  }
}
 
#include "gz/plugin/detail/Plugin.hh"
 
#endif