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 IGNITION_COMMON_PLUGIN_HH_
#define IGNITION_COMMON_PLUGIN_HH_
 
#include <memory>
#include <map>
#include <string>
 
#include <ignition/common/config.hh>
#include <gz/common/Export.hh>
#include <gz/utils/SuppressWarning.hh>
 
namespace gz
{
  namespace common
  {
    // Forward declarations
    struct PluginInfo;
    class PluginPrivate;
    namespace detail { template <class, class> class ComposePlugin; }
 
    class IGNITION_COMMON_VISIBLE Plugin
    {
      // -------------------- Public API ---------------------
 
      public: template <class Interface>
              Interface *QueryInterface();
 
      public: template <class Interface>
              const Interface *QueryInterface() const;
 
      public: template <class Interface>
              Interface *QueryInterface(const std::string &_interfaceName);
 
      public: template <class Interface>
              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>
              std::shared_ptr<Interface> QueryInterfaceSharedPtr(
                  const std::string &_interfaceName);
 
      public: template <class Interface>
              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;
 
 
      // -------------------- Private API -----------------------
 
      template <class> friend class TemplatePluginPtr;
      template <class...> friend class SpecializedPlugin;
      template <class, class> friend class detail::ComposePlugin;
 
      private: GZ_DEPRECATED(5) Plugin();
 
      private: void *PrivateGetInterface(
                  const std::string &_interfaceName) const;
 
      private: void PrivateCopyPluginInstance(const Plugin &_other) const;
 
      private: void PrivateSetPluginInstance(const PluginInfo *_info) const;
 
      private: const std::shared_ptr<void>& PrivateGetInstancePtr() const;
 
      public: using InterfaceMap = std::map<std::string, void*>;
 
      private: InterfaceMap::iterator PrivateGetOrCreateIterator(
          const std::string &_interfaceName);
 
      GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: const std::unique_ptr<PluginPrivate> dataPtr;
      GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
 
      public: virtual ~Plugin();
    };
  }
}
 
#include "ignition/common/detail/Plugin.hh"
 
#endif