This file documents preprocessor macros that are usually defined on the command-line to the compiler. More...

Macros
#define	QP_CONFIG
	The preprocessor switch to activate the QP configuration file qp_config.h.

#define	Q_SPY
	The preprocessor switch to activate the QS software tracing instrumentation in QP/C Framework and QP Application code.

#define	Q_UTEST
	The preprocessor switch to activate the QUTest testing instrumentation in QP/C Framework and QP Application code.

Detailed Description

This file documents preprocessor macros that are usually defined on the command-line to the compiler.

Definition in file cmd_options.dox.

Macro Definition Documentation

#define QP_CONFIG

The preprocessor switch to activate the QP configuration file qp_config.h.

Details: When defined, QP_CONFIG causes the QP/C port to include the qp_config.h header file, which must be available on the include path to the compiler.

Definition at line 11 of file cmd_options.dox.

#define Q_SPY

The preprocessor switch to activate the QS software tracing instrumentation in QP/C Framework and QP Application code.

Details: When defined, Q_SPY activates the QS software tracing instrumentation. When Q_SPY is not defined, the QS instrumentation in the code does not generate any code.

Note: The Q_SPY is typically defined only in the Spy build configuration and is not defined in other build configurations.

Definition at line 21 of file cmd_options.dox.

#define Q_UTEST

The preprocessor switch to activate the QUTest testing instrumentation in QP/C Framework and QP Application code.

Details: When defined, Q_UTEST activates the QUTest testing instrumentation, which also requires QS software tracing (see Q_SPY).

Also, the Q_UTEST macro can have a value that decides whether the QP Framework "stub" is included or not. The following values are supported:

#define Q_UTEST   // the %QP Framework testing "stub" is included
 
#define Q_UTEST 0 // the %QP Framework testing "stub" is NOT included

Definition at line 38 of file cmd_options.dox.