gz/common/PluginMacros.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_REGISTERMACROS_HH_
#define IGNITION_COMMON_REGISTERMACROS_HH_
 
#include <gz/common/config.hh>
#include "gz/common/detail/PluginMacros.hh"
 
// --------------- Specialize a plugin interface (optional) -------------------
 
#define IGN_COMMON_SPECIALIZE_INTERFACE(interfaceName)\
  DETAIL_IGN_COMMON_SPECIALIZE_INTERFACE(interfaceName)
 
 
// ------------- Add a set of plugins or a set of interfaces ------------------
 
// The following three macros can be used to produce multiple plugins and/or
// multiple interfaces from your shared library.
 
/* Usage example for multiple plugins and one interface:
 *
 *     IGN_COMMON_BEGIN_ADDING_PLUGINS
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeClass1, mylibrary::ns::SomeInterface)
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeClass2, mylibrary::ns::SomeInterface)
 *     IGN_COMMON_FINISH_ADDING_PLUGINS
 *
 *
 * Usage example for one plugin and multiple interfaces:
 *
 *     IGN_COMMON_BEGIN_ADDING_PLUGINS
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeClass, mylibrary::ns::Interface1)
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeClass, mylibrary::ns::Interface2)
 *     IGN_COMMON_FINISH_ADDING_PLUGINS
 *
 *
 * Usage example for multiple plugins and multiple interfaces:
 *
 *     IGN_COMMON_BEGIN_ADDING_PLUGINS
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeClass, mylibrary::ns::FooInterface)
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeOtherClass, mylibrary::ns::BarInterface)
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeClass, mylibrary::ns::SomeInterface)
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeOtherClass, mylibrary::ns::FooInterface)
 *       IGN_COMMON_ADD_PLUGIN(mylibrary::ns::SomeOtherClass, mylibrary::ns::SomeInterface)
 *     IGN_COMMON_FINISH_ADDING_PLUGINS
 */
 
// Note that the order in which (Plugin, Interface) pairs are added does not
// matter. Multiple plugins are allowed to provide the same interface. There is
// no inherent limit on the number of interfaces or plugins that are allowed.
//
// These macros MUST be called in the global namespace in a source file of your
// library's codebase. A single library is only allowed to have ONE block of
// these macros (i.e. if you find yourself invoking
// IGN_COMMON_BEGIN_ADDING_PLUGINS more than once in your library, then you are
// doing something that is not permitted). Recommended practice is to have a
// single source file (e.g. plugins.cpp) in your library's codebase that is
// dedicated to hosting these macros.
 
 
#define IGN_COMMON_BEGIN_ADDING_PLUGINS\
  DETAIL_IGN_COMMON_BEGIN_ADDING_PLUGINS
 
 
#define IGN_COMMON_ADD_PLUGIN(plugin, interface)\
  DETAIL_IGN_COMMON_ADD_PLUGIN(plugin, interface)
 
 
#define IGN_COMMON_FINISH_ADDING_PLUGINS\
  DETAIL_IGN_COMMON_FINISH_ADDING_PLUGINS
 
 
// -------------- Add a single plugin with a single interface -----------------
 
#define IGN_COMMON_REGISTER_SINGLE_PLUGIN(plugin, interface) \
  IGN_COMMON_BEGIN_ADDING_PLUGINS\
    IGN_COMMON_ADD_PLUGIN(plugin, interface)\
  IGN_COMMON_FINISH_ADDING_PLUGINS
 
#endif