ADTF  3.18.2
preprocessor functionality

Component for common preprocessor functionality and macros - applicable using

#include <a_util/preprocessor.h> More...

Macros

#define A_UTIL_CURRENT_FUNCTION   BOOST_CURRENT_FUNCTION
 Resolves to the name of the function this macro is used in.
 
#define DEV_ESSENTIAL_DEPRECATED(msg)
 Adds [[deprecated("msg")]] to allowed declarations. More...
 
#define A_UTIL_DISABLE_COMPILER_WARNINGS
 Disables all compiler warnings until A_UTIL_ENABLE_COMPILER_WARNINGS is found. More...
 
#define A_UTIL_ENABLE_COMPILER_WARNINGS
 Restores the compiler warning level to the state before A_UTIL_DISABLE_COMPILER_WARNINGS. More...
 
#define A_UTIL_DLL_EXPORT
 Defines standard exporting rules for symbol visibility. More...
 
#define A_UTIL_TO_STRING(expression)   A_UTIL_STRINGIFY(expression)
 Converts an expression to its string representation during preprocessing. More...
 

Detailed Description

Component for common preprocessor functionality and macros - applicable using

#include <a_util/preprocessor.h>

Macro Definition Documentation

◆ A_UTIL_DISABLE_COMPILER_WARNINGS

#define A_UTIL_DISABLE_COMPILER_WARNINGS

Disables all compiler warnings until A_UTIL_ENABLE_COMPILER_WARNINGS is found.

Might be used to disable warnings for third-party includes that cannot be changed. Example:

// disables ALL wanings
#include <some/thirdparty/header.h>
// must be called to restore the previous warning state
#define A_UTIL_DISABLE_COMPILER_WARNINGS
Disables all compiler warnings until A_UTIL_ENABLE_COMPILER_WARNINGS is found.
#define A_UTIL_ENABLE_COMPILER_WARNINGS
Restores the compiler warning level to the state before A_UTIL_DISABLE_COMPILER_WARNINGS.
Note
For internal usage only

Definition at line 46 of file disable_warnings.h.

◆ A_UTIL_DLL_EXPORT

#define A_UTIL_DLL_EXPORT

Defines standard exporting rules for symbol visibility.

Macro for switching between export / import.

Definition at line 40 of file dll_export.h.

◆ A_UTIL_ENABLE_COMPILER_WARNINGS

#define A_UTIL_ENABLE_COMPILER_WARNINGS

Restores the compiler warning level to the state before A_UTIL_DISABLE_COMPILER_WARNINGS.

For an example, see A_UTIL_DISABLE_COMPILER_WARNINGS.

Note
For internal usage only

Definition at line 47 of file disable_warnings.h.

◆ A_UTIL_TO_STRING

#define A_UTIL_TO_STRING (   expression)    A_UTIL_STRINGIFY(expression)

Converts an expression to its string representation during preprocessing.

Parameters
[in]expressionThe expression evaluating to the string representation.

Definition at line 31 of file to_string.h.

◆ DEV_ESSENTIAL_DEPRECATED

#define DEV_ESSENTIAL_DEPRECATED (   msg)
Value:
[[deprecated(msg " To disable this warning, define " \
"DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS.")]]

Adds [[deprecated("msg")]] to allowed declarations.

Parameters
[in]msgText explaining the rationale for deprecation and/or to suggest a replacing entity
Remarks
Might be disabled by defining preprocessor define DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS.
Allowed declarations are listed here: https://en.cppreference.com/w/cpp/language/attributes/deprecated#Explanation.

Definition at line 28 of file deprecated.h.