api.h

Go to the documentation of this file.

/*
 * Copyright 2015-2019 CNRS-UM LIRMM, CNRS-AIST JRL
 */
 
#pragma once
 
// Package version (header).
#define MC_ROBOTS_VERSION "UNKNOWN-dirty"
 
// Handle portable symbol export.
// Defining manually which symbol should be exported is required
// under Windows whether MinGW or MSVC is used.
//
// The headers then have to be able to work in two different modes:
// - dllexport when one is building the library,
// - dllimport for clients using the library.
//
// On Linux, set the visibility accordingly. If C++ symbol visibility
// is handled by the compiler, see: http://gcc.gnu.org/wiki/Visibility
#if defined _WIN32 || defined __CYGWIN__
// On Microsoft Windows, use dllimport and dllexport to tag symbols.
#  define MC_ROBOTS_DLLIMPORT __declspec(dllimport)
#  define MC_ROBOTS_DLLEXPORT __declspec(dllexport)
#  define MC_ROBOTS_DLLLOCAL
#else
// On Linux, for GCC >= 4, tag symbols using GCC extension.
#  if __GNUC__ >= 4
#    define MC_ROBOTS_DLLIMPORT __attribute__((visibility("default")))
#    define MC_ROBOTS_DLLEXPORT __attribute__((visibility("default")))
#    define MC_ROBOTS_DLLLOCAL __attribute__((visibility("hidden")))
#  else
// Otherwise (GCC < 4 or another compiler is used), export everything.
#    define MC_ROBOTS_DLLIMPORT
#    define MC_ROBOTS_DLLEXPORT
#    define MC_ROBOTS_DLLLOCAL
#  endif // __GNUC__ >= 4
#endif // defined _WIN32 || defined __CYGWIN__
 
#ifdef MC_ROBOTS_STATIC
// If one is using the library statically, get rid of
// extra information.
#  define MC_ROBOTS_DLLAPI
#  define MC_ROBOTS_LOCAL
#else
// Depending on whether one is building or using the
// library define DLLAPI to import or export.
#  ifdef MC_ROBOTS_EXPORTS
#    define MC_ROBOTS_DLLAPI MC_ROBOTS_DLLEXPORT
#  else
#    define MC_ROBOTS_DLLAPI MC_ROBOTS_DLLIMPORT
#  endif // MC_ROBOTS_EXPORTS
#  define MC_ROBOTS_LOCAL MC_ROBOTS_DLLLOCAL
#endif // MC_ROBOTS_STATIC