PluginLoader.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_PLUGINLOADER_HH_
#define IGNITION_COMMON_PLUGINLOADER_HH_

#include <memory>
#include <string>
#include <typeinfo>
#include <unordered_set>

#include <ignition/common/Export.hh>
#include <ignition/common/SuppressWarning.hh>
#include <ignition/common/PluginPtr.hh>

namespace ignition
{
  namespace common
  {
    class PluginLoaderPrivate;
    struct PluginInfo;

    class IGNITION_COMMON_VISIBLE PluginLoader
    {
      public: PluginLoader();

      public: ~PluginLoader();

      public: std::string PrettyStr() const;

      public: std::unordered_set<std::string> InterfacesImplemented() const;

      public: std::unordered_set<std::string> PluginsImplementing(
                  const std::string &_interface) const;

      public: std::unordered_set<std::string> LoadLibrary(
                  const std::string &_pathToLibrary);

      public: PluginPtr Instantiate(const std::string &_pluginName) const;

      public: template <typename PluginPtrType>
              PluginPtrType Instantiate(
                  const std::string &_pluginName) const;

      private: const PluginInfo *PrivateGetPluginInfo(
                  const std::string &_pluginName) const;

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<PluginLoaderPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}

#include "ignition/common/detail/PluginLoader.hh"

#endif