YARP  2.3.68+272-20170522.1+git50f0ae7
Yet Another Robot Platform
system.h File Reference
+ Include dependency graph for system.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define YARP_WRAP_STL_STRING
 
#define YARP_WRAP_STL_STRING_INLINE
 
#define YARP_USE_STL   1
 
#define YARP_HAS_EXECINFO
 
#define YARP_POINTER_SIZE   8
 
#define __YARP_DO_PRAGMA(x)   _Pragma (#x)
 
#define YARP_COMPILER_MESSAGE(x)   __YARP_DO_PRAGMA(message #x)
 Print a message at build time on supported compilers. More...
 
#define YARP_COMPILER_WARNING(x)   __YARP_DO_PRAGMA(GCC warning #x)
 Generate a warning at build time on supported compilers. More...
 
#define YARP_COMPILER_ERROR(x)   __YARP_DO_PRAGMA(GCC error #x)
 Generate an error at build time on supported compilers. More...
 
#define YARP_COMPILER_DEPRECATED_WARNING(x)   YARP_COMPILER_WARNING(x)
 Generate a warning at build time on supported compilers if deprecated warnings are enabled. More...
 
#define YARP_BEGIN_PACK   _Pragma("pack(1)")
 Starts 1 byte packing for structs/classes. More...
 
#define YARP_END_PACK   _Pragma("pack()")
 Ends 1 byte packing for structs/classes. More...
 
#define YARP_WARNING_PUSH   _Pragma("GCC diagnostic push")
 Starts a temporary alteration of the enabled warnings. More...
 
#define YARP_WARNING_POP   _Pragma("GCC diagnostic pop")
 Ends a temporary alteration of the enabled warnings. More...
 
#define YARP_DISABLE_DEPRECATED_WARNING   _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
 Disable deprecated warnings in the following code. More...
 

Macro Definition Documentation

◆ __YARP_DO_PRAGMA

#define __YARP_DO_PRAGMA (   x)    _Pragma (#x)

Definition at line 116 of file system.h.

◆ YARP_BEGIN_PACK

#define YARP_BEGIN_PACK   _Pragma("pack(1)")

Starts 1 byte packing for structs/classes.

Instructs the compiler that the following structure/class has to be packed with 1 byte boundary. This is conditionally generated depending on the compiler and architecture. It assures interoperability of network communication between compilers.

See also
Datatypes, YARP_END_PACK
Examples:
port_power/TargetVer1.h, and port_power/TargetVer1b.h.

Definition at line 204 of file system.h.

◆ YARP_COMPILER_DEPRECATED_WARNING

#define YARP_COMPILER_DEPRECATED_WARNING (   x)    YARP_COMPILER_WARNING(x)

Generate a warning at build time on supported compilers if deprecated warnings are enabled.

This can be useful for example to deprecate a header file.

Parameters
xDeprecation message.
See also
YARP_COMPILER_MESSAGE, YARP_COMPILER_WARNING, YARP_COMPILER_ERROR

Definition at line 127 of file system.h.

◆ YARP_COMPILER_ERROR

#define YARP_COMPILER_ERROR (   x)    __YARP_DO_PRAGMA(GCC error #x)

Generate an error at build time on supported compilers.

For example:

YARP_COMPILER_ERROR(This is a custom compiler error)

will generate an error "This is a custom compiler error".

Parameters
xError message.
See also
YARP_COMPILER_MESSAGE, YARP_COMPILER_WARNING, YARP_COMPILER_DEPRECATED_WARNING

Definition at line 119 of file system.h.

◆ YARP_COMPILER_MESSAGE

#define YARP_COMPILER_MESSAGE (   x)    __YARP_DO_PRAGMA(message #x)

Print a message at build time on supported compilers.

For example:

YARP_COMPILER_MESSAGE(This is a custom compiler message)

will print "This is a custom compiler message".

Parameters
xMessage.
See also
YARP_COMPILER_WARNING, YARP_COMPILER_ERROR, YARP_COMPILER_DEPRECATED_WARNING

Definition at line 117 of file system.h.

◆ YARP_COMPILER_WARNING

#define YARP_COMPILER_WARNING (   x)    __YARP_DO_PRAGMA(GCC warning #x)

Generate a warning at build time on supported compilers.

For example:

YARP_COMPILER_WARNING(This is a custom compiler warning)

will generate a warning "This is a custom compiler warning"

Parameters
xWarning message.
See also
YARP_COMPILER_MESSAGE, YARP_COMPILER_ERROR, YARP_COMPILER_DEPRECATED_WARNING

Definition at line 118 of file system.h.

◆ YARP_DISABLE_DEPRECATED_WARNING

#define YARP_DISABLE_DEPRECATED_WARNING   _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")

Disable deprecated warnings in the following code.

It should be used in this way:

See also
YARP_WARNING_PUSH, YARP_WARNING_POP

Definition at line 259 of file system.h.

◆ YARP_END_PACK

#define YARP_END_PACK   _Pragma("pack()")

Ends 1 byte packing for structs/classes.

Instructs the compiler that the default packing can be reinstated.

See also
Datatypes YARP_BEGIN_PACK
Examples:
port_power/TargetVer1.h, and port_power/TargetVer1b.h.

Definition at line 206 of file system.h.

◆ YARP_HAS_EXECINFO

#define YARP_HAS_EXECINFO

Definition at line 34 of file system.h.

◆ YARP_POINTER_SIZE

#define YARP_POINTER_SIZE   8

Definition at line 36 of file system.h.

◆ YARP_USE_STL

#define YARP_USE_STL   1

Definition at line 27 of file system.h.

◆ YARP_WARNING_POP

#define YARP_WARNING_POP   _Pragma("GCC diagnostic pop")

Ends a temporary alteration of the enabled warnings.

See also
YARP_WARNING_PUSH

Definition at line 258 of file system.h.

◆ YARP_WARNING_PUSH

#define YARP_WARNING_PUSH   _Pragma("GCC diagnostic push")

Starts a temporary alteration of the enabled warnings.

See also
YARP_WARNING_POP

Definition at line 257 of file system.h.

◆ YARP_WRAP_STL_STRING

#define YARP_WRAP_STL_STRING

Definition at line 15 of file system.h.

◆ YARP_WRAP_STL_STRING_INLINE

#define YARP_WRAP_STL_STRING_INLINE

Definition at line 16 of file system.h.