macros.hpp File Reference

Various macros useful for development. More...

#include <ecl/config/ecl.hpp>
Include dependency graph for macros.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


 Deprecated compiler warnings.
 Prevents a function from being inlined.
 Declare public visibility for libraries.
#define ECL_LOCAL
#define ECL_PUBLIC

Detailed Description

Various macros useful for development.

September 2010

Definition in file macros.hpp.

Define Documentation

Declare public visibility for libraries.

This emits (in a cross platform way) the required symbols for setting whether a function/class should be visible or hidden. Note only does this protect the private parts of your library, but it can also greatly speed up the linking process.

To check what symbols are being exported for a gnu library,

 nm -C -D <library>.so


Each package needs to create it's own macro to make use of the macro that cmake defines for library targets:

 #ifdef ROS_BUILD_SHARED_LIBS // ros is being built around shared libraries
   #ifdef ecl_common_EXPORTS // we are building a shared lib/dll
     #define ecl_common_PUBLIC ROS_HELPER_EXPORT
   #else // we are using shared lib/dll
     #define ecl_common_PUBLIC ROS_HELPER_IMPORT
 #else // ros is being built around static libraries
   #define ecl_common_DECL

And use it alongside class or function definitions:

 extern "C" ecl_common_PUBLIC void function(int a);
 class ecl_common_PUBLIC SomeClass {
     int c;
     ecl_common_LOCAL void privateMethod();  // Only for use within this DSO
     Person(int _c) : c(_c) { }
     static void foo(int a);
See also:

Definition at line 144 of file macros.hpp.

See also:

Definition at line 143 of file macros.hpp.

See also:

Definition at line 145 of file macros.hpp.

#define ECL_LOCAL

Definition at line 151 of file macros.hpp.

#define ECL_PUBLIC

Definition at line 150 of file macros.hpp.

Author(s): Daniel Stonier
autogenerated on Wed Aug 26 2015 11:27:12