QP/C++ public interface including backwards-compatibility layer. More...

#include "qf_port.hpp"
#include "qassert.h"
#include "qs_port.hpp"

Macros
#define	QP_API_VERSION 0
	Macro that specifies the backwards compatibility with the QP/C++ API version.

#define	QF_NO_MARGIN QP::QF::NO_MARGIN

#define	Q_ASSERT_COMPILE(expr_) Q_ASSERT_STATIC(expr_)
	Static (compile-time) assertion.

#define	QS_FILTER_ON(rec_) QS_GLB_FILTER((rec_))

#define	QS_FILTER_OFF(rec_) QS_GLB_FILTER(-(rec_))

#define	QS_FILTER_SM_OBJ(obj_) (static_cast<void>(0))

#define	QS_FILTER_AO_OBJ(obj_) (static_cast<void>(0))

#define	QS_FILTER_MP_OBJ(obj_) (static_cast<void>(0))

#define	QS_FILTER_EQ_OBJ(obj_) (static_cast<void>(0))

#define	QS_FILTER_TE_OBJ(obj_) (static_cast<void>(0))

#define	QS_FILTER_AP_OBJ(obj_) (QP::QS::priv_.locFilter_AP = (obj_))

#define	QS_BEGIN(rec_, obj_)

#define	QS_U32_HEX(width_, data_)

#define	Q_TRAN(target_) (me->tran(Q_STATE_CAST(target_)))

#define	Q_TRAN_HIST(hist_) (me->tran_hist((hist_)))

#define	Q_SUPER(state_) (me->super(Q_STATE_CAST(state_)))

#define	QM_ENTRY(state_) (me->qm_entry((state_)))

#define	QM_EXIT(state_) (me->qm_exit((state_)))

#define	QM_SM_EXIT(state_) (me->qm_sm_exit((state_)))

#define	QM_TRAN(tatbl_) (me->qm_tran((tatbl_)))

#define	QM_TRAN_INIT(tatbl_) (me->qm_tran_init((tatbl_)))

#define	QM_TRAN_HIST(history_, tatbl_) (me->qm_tran_hist((history_), (tatbl_)))

#define	QM_TRAN_EP(tatbl_) (me->qm_tran_ep((tatbl_)))

#define	QM_TRAN_XP(xp_, tatbl_) (me->qm_tran_xp((xp_), (tatbl_)))

#define	QM_SUPER_SUB(state_) (me->qm_super_sub((state_)))

Typedefs
using	char_t = char

Detailed Description

This header file must be included directly or indirectly in all application modules (*.cpp files) that use QP/C++.

Definition in file qpcpp.hpp.

Macro Definition Documentation

◆ QP_API_VERSION

#define QP_API_VERSION 0

For example, QP_API_VERSION=540 will cause generating the compatibility layer with QP/C++ version 5.4.0 and newer, but not older than 5.4.0. QP_API_VERSION=0 causes generation of the compatibility layer "from the begining of time", which is the maximum backwards compatibilty. This is the default.

Conversely, QP_API_VERSION=9999 means that no compatibility layer should be generated. This setting is useful for checking if an application complies with the latest QP/C++ API.

Definition at line 74 of file qpcpp.hpp.

◆ QF_NO_MARGIN

#define QF_NO_MARGIN QP::QF::NO_MARGIN

Deprecated:: use QP::QF::NO_MARGIN instead

Definition at line 83 of file qpcpp.hpp.

◆ Q_ASSERT_COMPILE

#define Q_ASSERT_COMPILE ( expr_ ) Q_ASSERT_STATIC(expr_)

Deprecated:: Use Q_ASSERT_STATIC() or better yet static_assert() instead.

Definition at line 93 of file qpcpp.hpp.

◆ QS_FILTER_ON

#define QS_FILTER_ON ( rec_ ) QS_GLB_FILTER((rec_))

Deprecated:: enable the QS global filter

Definition at line 99 of file qpcpp.hpp.

◆ QS_FILTER_OFF

#define QS_FILTER_OFF ( rec_ ) QS_GLB_FILTER(-(rec_))

Deprecated:: disable the QS global filter

Definition at line 102 of file qpcpp.hpp.

◆ QS_FILTER_SM_OBJ

#define QS_FILTER_SM_OBJ ( obj_ ) (static_cast<void>(0))

Deprecated:: enable the QS local filter for SM (state machine) object

Definition at line 105 of file qpcpp.hpp.

◆ QS_FILTER_AO_OBJ

#define QS_FILTER_AO_OBJ ( obj_ ) (static_cast<void>(0))

Deprecated:: enable the QS local filter for AO (active objects)

Definition at line 108 of file qpcpp.hpp.

◆ QS_FILTER_MP_OBJ

#define QS_FILTER_MP_OBJ ( obj_ ) (static_cast<void>(0))

Deprecated:: enable the QS local filter for MP (memory pool) object

Definition at line 111 of file qpcpp.hpp.

◆ QS_FILTER_EQ_OBJ

#define QS_FILTER_EQ_OBJ ( obj_ ) (static_cast<void>(0))

Deprecated:: enable the QS local filter for EQ (event queue) object

Definition at line 114 of file qpcpp.hpp.

◆ QS_FILTER_TE_OBJ

#define QS_FILTER_TE_OBJ ( obj_ ) (static_cast<void>(0))

Deprecated:: enable the QS local filter for TE (time event) object

Definition at line 117 of file qpcpp.hpp.

◆ QS_FILTER_AP_OBJ

#define QS_FILTER_AP_OBJ ( obj_ ) (QP::QS::priv_.locFilter_AP = (obj_))

Deprecated:: local Filter for a generic application object obj_.

Definition at line 122 of file qpcpp.hpp.

◆ QS_BEGIN

#define QS_BEGIN	(	rec_,
		obj_
	)

Value:

    if (QS_GLB_FILTER_(rec_) &&                                  \
        ((QP::QS::priv_.locFilter[QP::QS::AP_OBJ] == nullptr)    \
            || (QP::QS::priv_.locFilter_AP == (obj_))))          \
    {                                                            \
        QS_CRIT_STAT_                                            \
        QS_CRIT_E_();                                            \
        QP::QS::beginRec_(static_cast<std::uint_fast8_t>(rec_)); \
        QS_TIME_PRE_();

Deprecated:: begin of a user QS record, instead use QS_BEGIN_ID()

Definition at line 126 of file qpcpp.hpp.

◆ QS_U32_HEX

#define QS_U32_HEX	(	width_,
		data_
	)

Value:

(QP::QS::u32_fmt_(static_cast<std::uint8_t>( \

(static_cast<std::uint8_t>((width_) << 4)) | QS_HEX_FMT), (data_)))

QP::QS::u32_fmt_

void u32_fmt_(std::uint8_t format, std::uint32_t d) noexcept

Output std::uint32_t data element with format information.

Definition: qs.cpp:653

QS_HEX_FMT

#define QS_HEX_FMT

Constant representing HEX format for the "width" filed in QS_U8(), QS_U16(), QS_U32(),...

Definition: qs.hpp:1366

Deprecated:: output hex-formatted std::uint32_t to the QS record

Definition at line 137 of file qpcpp.hpp.

◆ Q_TRAN

#define Q_TRAN ( target_ ) (me->tran(Q_STATE_CAST(target_)))

Deprecated:: Macro to specify a transition in the "me->" impl-strategy. Instead use the new impl-strategy without the "me->" pointer, where you call tran(Q_STATE_CAST(target_)).

Definition at line 156 of file qpcpp.hpp.

◆ Q_TRAN_HIST

#define Q_TRAN_HIST ( hist_ ) (me->tran_hist((hist_)))

Deprecated:: Macro to specify a tran-to-history in the "me->" impl-strategy. Instead use the new impl-strategy without the "me->" pointer, where you call tran_hist(Q_STATE_CAST(hist_)).

Definition at line 162 of file qpcpp.hpp.

◆ Q_SUPER

#define Q_SUPER ( state_ ) (me->super(Q_STATE_CAST(state_)))

Deprecated:: Macro to specify the superstate in the "me->" impl-strategy. Instead use the new impl-strategy without the "me->" pointer, where you call super(state_)).

Definition at line 168 of file qpcpp.hpp.

◆ QM_ENTRY

#define QM_ENTRY ( state_ ) (me->qm_entry((state_)))

Deprecated:: Macro to call in a QM state entry-handler. Applicable only to QMSMs. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_entry(Q_STATE_CAST(state_)).

Definition at line 174 of file qpcpp.hpp.

◆ QM_EXIT

#define QM_EXIT ( state_ ) (me->qm_exit((state_)))

Deprecated:: Macro to call in a QM state exit-handler. Applicable only to QMSMs. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_exit(Q_STATE_CAST(state_)).

Definition at line 180 of file qpcpp.hpp.

◆ QM_SM_EXIT

#define QM_SM_EXIT ( state_ ) (me->qm_sm_exit((state_)))

Deprecated:: Macro to call in a QM submachine exit-handler. Applicable only to QMSMs. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_sm_exit(Q_STATE_CAST(state_)).

Definition at line 186 of file qpcpp.hpp.

◆ QM_TRAN

#define QM_TRAN ( tatbl_ ) (me->qm_tran((tatbl_)))

Deprecated:: Macro to call in a QM state-handler when it executes a transition. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_tran((tatbl_)).

Definition at line 192 of file qpcpp.hpp.

◆ QM_TRAN_INIT

#define QM_TRAN_INIT ( tatbl_ ) (me->qm_tran_init((tatbl_)))

Deprecated:: Macro to call in a QM state-handler when it executes an initial tran. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_tran_init((tatbl_)).

Definition at line 198 of file qpcpp.hpp.

◆ QM_TRAN_HIST

#define QM_TRAN_HIST	(	history_,
		tatbl_
	)	(me->qm_tran_hist((history_), (tatbl_)))

Deprecated:: Macro to call in a QM state-handler when it executes a tran-to-history. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_tran_hist((history_), (tatbl_)).

Definition at line 204 of file qpcpp.hpp.

◆ QM_TRAN_EP

#define QM_TRAN_EP ( tatbl_ ) (me->qm_tran_ep((tatbl_)))

Deprecated:: Macro to call in a QM state-handler when it executes an initial tran. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_tran_ep((tatbl_)).

Definition at line 211 of file qpcpp.hpp.

◆ QM_TRAN_XP

#define QM_TRAN_XP	(	xp_,
		tatbl_
	)	(me->qm_tran_xp((xp_), (tatbl_)))

Deprecated:: Macro to call in a QM state-handler when it executes a tran-to-exit-point. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_tran_xp((xp_), (tatbl_)).

Definition at line 217 of file qpcpp.hpp.

◆ QM_SUPER_SUB

#define QM_SUPER_SUB ( state_ ) (me->qm_super_sub((state_)))

Deprecated:: Designates the superstate of a given state in a subclass of QP::QMsm. Instead use the new impl-strategy without the "me->" pointer, where the QM-generated code calls qm_super_sub((state_)).

Definition at line 223 of file qpcpp.hpp.

Typedef Documentation

◆ char_t

using char_t = char

Deprecated:: plain 'char' is no longer forbidden in MISRA/AUTOSAR-C++

Definition at line 86 of file qpcpp.hpp.

Macros

Typedefs