gz/plugin/Loader.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_LOADER_HH_
#define GZ_PLUGIN_LOADER_HH_
 
#include <memory>
#include <set>
#include <string>
#include <typeinfo>
#include <unordered_set>
 
#include <gz/utils/SuppressWarning.hh>
 
#include <gz/plugin/loader/Export.hh>
#include <gz/plugin/PluginPtr.hh>
 
namespace gz
{
  namespace plugin
  {
    class GZ_PLUGIN_LOADER_VISIBLE Loader
    {
      public: Loader();
 
      public: ~Loader();
 
      public: std::string PrettyStr() const;
 
      public: std::unordered_set<std::string> InterfacesImplemented() const;
 
      public: template <typename Interface>
      std::unordered_set<std::string> PluginsImplementing() const;
 
      public: std::unordered_set<std::string> PluginsImplementing(
          const std::string &_interface,
          const bool _demangled = true) const;
 
      public: std::set<std::string> AllPlugins() const;
 
      public: std::set<std::string> PluginsWithAlias(
          const std::string &_alias) const;
 
      public: std::set<std::string> AliasesOfPlugin(
          const std::string &_pluginName) const;
 
      public: std::string LookupPlugin(const std::string &_nameOrAlias) const;
 
      public: std::unordered_set<std::string> LoadLib(
                  const std::string &_pathToLibrary);
 
      public: std::unordered_set<std::string> LoadLib(
                  const std::string &_pathToLibrary, bool _noDelete);
 
      public: PluginPtr Instantiate(
          const std::string &_pluginNameOrAlias) const;
 
      public: template <typename PluginPtrType>
      PluginPtrType Instantiate(const std::string &_pluginNameOrAlias) const;
 
      public: template <typename InterfaceType>
      std::shared_ptr<InterfaceType> Factory(
          const std::string &_pluginNameOrAlias) const;
 
      public: bool ForgetLibrary(const std::string &_pathToLibrary);
 
      public: bool ForgetLibraryOfPlugin(const std::string &_pluginNameOrAlias);
 
      private: std::string PrivateLookupFilePlugin(
          const std::string &_nameOrAlias) const;
 
      private: ConstInfoPtr PrivateGetInfoForFilePlugin(
          const std::string &_resolvedName) const;
 
      private: std::string PrivateLookupStaticPlugin(
          const std::string &_nameOrAlias) const;
 
      private: ConstInfoPtr PrivateGetInfoForStaticPlugin(
          const std::string &_resolvedName) const;
 
      private: std::shared_ptr<void> PrivateGetPluginDlHandlePtr(
          const std::string &_resolvedName) const;
 
      class Implementation;
      GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<Implementation> dataPtr;
      GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
 
#include <gz/plugin/detail/Loader.hh>
 
#endif