rcutils  master
C API providing common utilities and data structures.
visibility_control_macros.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


#define RCUTILS_IMPORT   __attribute__ ((visibility("default")))
#define RCUTILS_EXPORT   __attribute__ ((visibility("default")))
#define RCUTILS_LOCAL   __attribute__ ((visibility("hidden")))

Macro Definition Documentation


#define RCUTILS_IMPORT   __attribute__ ((visibility("default")))

Defines macros to express whether a symbol is localed, imported, or exported

Those macros are compatible with GCC, clang, and Microsoft Visual C++. They can be used to enforce which symbols of a library are publicly accessible.

RCUTILS_IMPORT, RCUTILS_EXPORT, and RCUTILS_LOCAL are respectively declaring an imported, exported, or local symbol. RCUTILS_LOCAL can be used directly. However, RCUTILS_IMPORT, and RCUTILS_EXPORT may not be used directly. Every project need to provide an additional header called visibility_macros.h containing:

#ifdef <project>_BUILDING_DLL

define <project>_PUBLIC RCUTILS_EXPORT


define <project>_PUBLIC RCUTILS_IMPORT

#endif // !<project>_BUILDING_DLL #define <project>_LOCAL RCUTILS_LOCAL

...where "<project>" has been replaced by the project name, such as "MY_PROJECT". Your project CMakeLists.txt should also contain the following statement:

target_compile_definitions(<your library> PRIVATE "<project>_BUILDING_DLL")

A public (exported) class should then be tagged as <project>_PUBLIC, whereas a non-public class should be tagged with <project>_LOCAL.

See GCC documentation: https://gcc.gnu.org/wiki/Visibility


#define RCUTILS_EXPORT   __attribute__ ((visibility("default")))


#define RCUTILS_LOCAL   __attribute__ ((visibility("hidden")))