Host API. More...

Go to the source code of this file.

Classes
struct	QSpyRecord

struct	QSpyConfig

struct	QSPY_LastOutput

struct	DictEntry

struct	Dictionary

struct	SigDictEntry

struct	SigDictionary

Macros
#define	QSPY_VER "7.4.0"

#define	SIG_NOT_FOUND ((SigType)-1)

#define	KEY_NOT_FOUND ((KeyType)-1)

#define	QS_LINE_OFFSET 8

#define	SNPRINTF_LINE(format_, ...)

#define	SNPRINTF_APPEND(format_, ...)

#define	CONFIG_UPDATE(member_, new_, diff_)

Typedefs
typedef uint16_t	QSignal

typedef int(*	QSPY_CustParseFun) (QSpyRecord *const me)

typedef void(*	QSPY_resetFun) (void)

typedef uint64_t	KeyType

typedef uint32_t	SigType

typedef uint64_t	ObjType

Enumerations
enum	QSpyStatus { QSPY_ERROR , QSPY_SUCCESS }

enum	{ QS_RECORD_SIZE_MAX = 512 , QS_LINE_LEN_MAX = 1000 , QS_FNAME_LEN_MAX = 256 , QS_SEQ_LIST_LEN_MAX = 300 , QS_DNAME_LEN_MAX = 64 }

enum	{ CMD_OPT_OFF , CMD_OPT_ON , CMD_OPT_TOGGLE }

enum	QSPY_LastOutputType { REG_OUT , ERR_OUT , BE_OUT , INF_OUT , USR_OUT , TST_OUT }

enum	QSRreRecGroup { GRP_ERR , GRP_INF , GRP_DIC , GRP_TST , GRP_SM , GRP_AO , GRP_EQ , GRP_MP , GRP_TE , GRP_QF , GRP_SC , GRP_SEM , GRP_MTX , GRP_USR }

Functions
void	QSpyRecord_init (QSpyRecord const me, uint8_t const start, uint32_t tot_len)

QSpyStatus	QSpyRecord_OK (QSpyRecord *const me)

uint32_t	QSpyRecord_getUint32 (QSpyRecord *const me, uint8_t size)

int32_t	QSpyRecord_getInt32 (QSpyRecord *const me, uint8_t size)

uint64_t	QSpyRecord_getUint64 (QSpyRecord *const me, uint8_t size)

int64_t	QSpyRecord_getInt64 (QSpyRecord *const me, uint8_t size)

char const *	QSpyRecord_getStr (QSpyRecord *const me)

uint8_t const *	QSpyRecord_getMem (QSpyRecord const me, uint8_t size, uint32_t pNum)

void	QSPY_config (QSpyConfig const *config, QSPY_CustParseFun custParseFun)

void	QSPY_configTxReset (QSPY_resetFun txResetFun)

void	QSPY_configMatFile (void *matFile)

void	QSPY_reset (void)

void	QSPY_parse (uint8_t const *buf, uint32_t nBytes)

void	QSPY_txReset (void)

bool	QSPY_command (uint8_t cmdId, uint8_t opt)

void	QSPY_sendEvt (QSpyRecord const *const qrec)

void	QSPY_sendObj (QSpyRecord const *const qrec)

void	QSPY_sendCmd (QSpyRecord const *const qrec)

void	QSPY_sendTP (QSpyRecord const *const qrec)

void	QSPY_showNote (QSpyRecord const *const qrec)

uint32_t	QSPY_encode (uint8_t dstBuf, uint32_t dstSize, uint8_t const srcBuf, uint32_t srcBytes)

uint32_t	QSPY_encodeResetCmd (uint8_t *dstBuf, uint32_t dstSize)

uint32_t	QSPY_encodeInfoCmd (uint8_t *dstBuf, uint32_t dstSize)

uint32_t	QSPY_encodeTickCmd (uint8_t *dstBuf, uint32_t dstSize, uint8_t rate)

SigType	QSPY_findSig (char const *name, ObjType obj)

KeyType	QSPY_findObj (char const *name)

KeyType	QSPY_findFun (char const *name)

KeyType	QSPY_findUsr (char const *name)

KeyType	QSPY_findEnum (char const *name, uint8_t group)

void	QSPY_cleanup (void)

char const *	QSPY_tstampStr (void)

void	QSPY_onPrintLn (void)

void	QSPY_printInfo (void)

void	QSPY_printError (void)

QSRreRecGroup	QSPY_getGroup (int recId)

void	Dictionary_ctor (Dictionary const me, DictEntry sto, uint32_t capacity)

void	Dictionary_config (Dictionary *const me, int keySize)

char const *	Dictionary_at (Dictionary *const me, unsigned idx)

void	Dictionary_put (Dictionary const me, KeyType key, char const name)

char const *	Dictionary_get (Dictionary const me, KeyType key, char buf)

int	Dictionary_find (Dictionary *const me, KeyType key)

KeyType	Dictionary_findKey (Dictionary const me, char const name)

void	Dictionary_reset (Dictionary *const me)

void	SigDictionary_ctor (SigDictionary const me, SigDictEntry sto, uint32_t capacity)

void	SigDictionary_config (SigDictionary *const me, int ptrSize)

void	SigDictionary_put (SigDictionary const me, SigType sig, ObjType obj, char const name)

char const *	SigDictionary_get (SigDictionary const me, SigType sig, ObjType obj, char buf)

int	SigDictionary_find (SigDictionary *const me, SigType sig, ObjType obj)

SigType	SigDictionary_findSig (SigDictionary const me, char const name, ObjType obj)

void	SigDictionary_reset (SigDictionary *const me)

void	QSPY_resetAllDictionaries (void)

Variables
QSPY_LastOutput	QSPY_output

char const *const	QSPY_line

Detailed Description

Host API.

Date: Last updated on: 2024-06-21

Version: Last updated for version: 7.4.0

Definition in file qspy.h.

Macro Definition Documentation

◆ QSPY_VER

#define QSPY_VER "7.4.0"

Definition at line 40 of file qspy.h.

◆ SIG_NOT_FOUND

#define SIG_NOT_FOUND ((SigType)-1)

Definition at line 145 of file qspy.h.

◆ KEY_NOT_FOUND

#define KEY_NOT_FOUND ((KeyType)-1)

Definition at line 146 of file qspy.h.

◆ QS_LINE_OFFSET

#define QS_LINE_OFFSET 8

Definition at line 161 of file qspy.h.

◆ SNPRINTF_LINE

#define SNPRINTF_LINE	(		format_,
			... )

Value:

    do {                       \
    int n_ = SNPRINTF_S(&QSPY_output.buf[QS_LINE_OFFSET],      \
                (QS_LINE_LEN_MAX - QS_LINE_OFFSET),            \
                format_,  __VA_ARGS__);                        \
    if ((0 < n_) && (n_ < QS_LINE_LEN_MAX - QS_LINE_OFFSET)) { \
        QSPY_output.len = n_;                                  \
    }                                                          \
    else {                                                     \
        QSPY_output.len = QS_LINE_LEN_MAX - QS_LINE_OFFSET;    \
    }                                                          \
} while (0)

Definition at line 208 of file qspy.h.

◆ SNPRINTF_APPEND

#define SNPRINTF_APPEND	(		format_,
			... )

Value:

    do {                                 \
    int n_ = SNPRINTF_S(&QSPY_output.buf[QS_LINE_OFFSET + QSPY_output.len],\
                (QS_LINE_LEN_MAX - QS_LINE_OFFSET - QSPY_output.len),      \
                format_, __VA_ARGS__);                                     \
    if ((0 < n_)                                                           \
        && (n_ < QS_LINE_LEN_MAX - QS_LINE_OFFSET - QSPY_output.len)) {    \
        QSPY_output.len += n_;                                             \
    }                                                                      \
    else {                                                                 \
        QSPY_output.len = QS_LINE_LEN_MAX - QS_LINE_OFFSET;                \
    }                                                                      \
} while (0)

Definition at line 220 of file qspy.h.

◆ CONFIG_UPDATE

#define CONFIG_UPDATE	(	member_,
		new_,
		diff_ )

Value:

    if (QSPY_conf.member_ != (new_)) {      \
        QSPY_conf.member_ =  (new_);        \
        (diff_) = 1U;                       \
    } else (void)0

Definition at line 233 of file qspy.h.

Typedef Documentation

◆ QSignal

typedef uint16_t QSignal

typedef for inclusion of qpc_qs.h

Definition at line 53 of file qspy.h.

◆ QSPY_CustParseFun

typedef int(* QSPY_CustParseFun) (QSpyRecord *const me)

Definition at line 74 of file qspy.h.

◆ QSPY_resetFun

typedef void(* QSPY_resetFun) (void)

Definition at line 75 of file qspy.h.

◆ KeyType

typedef uint64_t KeyType

Definition at line 106 of file qspy.h.

◆ SigType

typedef uint32_t SigType

Definition at line 107 of file qspy.h.

◆ ObjType

typedef uint64_t ObjType

Definition at line 108 of file qspy.h.

Enumeration Type Documentation

◆ QSpyStatus

enum QSpyStatus

low-level facilities for configuring QSpy and parsing QS records ...

Enumerator
QSPY_ERROR
QSPY_SUCCESS

Definition at line 47 of file qspy.h.

◆ anonymous enum

anonymous enum

Enumerator
QS_RECORD_SIZE_MAX
QS_LINE_LEN_MAX
QS_FNAME_LEN_MAX
QS_SEQ_LIST_LEN_MAX
QS_DNAME_LEN_MAX

Definition at line 65 of file qspy.h.

◆ anonymous enum

anonymous enum

Enumerator
CMD_OPT_OFF
CMD_OPT_ON
CMD_OPT_TOGGLE

Definition at line 120 of file qspy.h.

◆ QSPY_LastOutputType

enum QSPY_LastOutputType

Enumerator
REG_OUT
ERR_OUT
BE_OUT
INF_OUT
USR_OUT
TST_OUT

Definition at line 162 of file qspy.h.

◆ QSRreRecGroup

enum QSRreRecGroup

Enumerator
GRP_ERR
GRP_INF
GRP_DIC
GRP_TST
GRP_SM
GRP_AO
GRP_EQ
GRP_MP
GRP_TE
GRP_QF
GRP_SC
GRP_SEM
GRP_MTX
GRP_USR

Definition at line 182 of file qspy.h.

Function Documentation

◆ QSpyRecord_init()

void QSpyRecord_init	(	QSpyRecord *const	me,
		uint8_t const *	start,
		uint32_t	tot_len )

◆ QSpyRecord_OK()

QSpyStatus QSpyRecord_OK ( QSpyRecord *const me )

◆ QSpyRecord_getUint32()

uint32_t QSpyRecord_getUint32	(	QSpyRecord *const	me,
		uint8_t	size )

◆ QSpyRecord_getInt32()

int32_t QSpyRecord_getInt32	(	QSpyRecord *const	me,
		uint8_t	size )

◆ QSpyRecord_getUint64()

uint64_t QSpyRecord_getUint64	(	QSpyRecord *const	me,
		uint8_t	size )

◆ QSpyRecord_getInt64()

int64_t QSpyRecord_getInt64	(	QSpyRecord *const	me,
		uint8_t	size )

◆ QSpyRecord_getStr()

char const * QSpyRecord_getStr ( QSpyRecord *const me )

◆ QSpyRecord_getMem()

uint8_t const * QSpyRecord_getMem	(	QSpyRecord *const	me,
		uint8_t	size,
		uint32_t *	pNum )

◆ QSPY_config()

void QSPY_config	(	QSpyConfig const *	config,
		QSPY_CustParseFun	custParseFun )

◆ QSPY_configTxReset()

void QSPY_configTxReset ( QSPY_resetFun txResetFun )

◆ QSPY_configMatFile()

void QSPY_configMatFile ( void * matFile )

◆ QSPY_reset()

void QSPY_reset ( void )

◆ QSPY_parse()

void QSPY_parse	(	uint8_t const *	buf,
		uint32_t	nBytes )

◆ QSPY_txReset()

void QSPY_txReset ( void )

◆ QSPY_command()

bool QSPY_command	(	uint8_t	cmdId,
		uint8_t	opt )

◆ QSPY_sendEvt()

void QSPY_sendEvt ( QSpyRecord const *const qrec )

◆ QSPY_sendObj()

void QSPY_sendObj ( QSpyRecord const *const qrec )

◆ QSPY_sendCmd()

void QSPY_sendCmd ( QSpyRecord const *const qrec )

◆ QSPY_sendTP()

void QSPY_sendTP ( QSpyRecord const *const qrec )

◆ QSPY_showNote()

void QSPY_showNote ( QSpyRecord const *const qrec )

◆ QSPY_encode()

uint32_t QSPY_encode	(	uint8_t *	dstBuf,
		uint32_t	dstSize,
		uint8_t const *	srcBuf,
		uint32_t	srcBytes )

◆ QSPY_encodeResetCmd()

uint32_t QSPY_encodeResetCmd	(	uint8_t *	dstBuf,
		uint32_t	dstSize )

◆ QSPY_encodeInfoCmd()

uint32_t QSPY_encodeInfoCmd	(	uint8_t *	dstBuf,
		uint32_t	dstSize )

◆ QSPY_encodeTickCmd()

uint32_t QSPY_encodeTickCmd	(	uint8_t *	dstBuf,
		uint32_t	dstSize,
		uint8_t	rate )

◆ QSPY_findSig()

SigType QSPY_findSig	(	char const *	name,
		ObjType	obj )

◆ QSPY_findObj()

KeyType QSPY_findObj ( char const * name )

◆ QSPY_findFun()

KeyType QSPY_findFun ( char const * name )

◆ QSPY_findUsr()

KeyType QSPY_findUsr ( char const * name )

◆ QSPY_findEnum()

KeyType QSPY_findEnum	(	char const *	name,
		uint8_t	group )

◆ QSPY_cleanup()

void QSPY_cleanup ( void )

◆ QSPY_tstampStr()

char const * QSPY_tstampStr ( void )

◆ QSPY_onPrintLn()

void QSPY_onPrintLn ( void )

◆ QSPY_printInfo()

void QSPY_printInfo ( void )

◆ QSPY_printError()

void QSPY_printError ( void )

◆ QSPY_getGroup()

QSRreRecGroup QSPY_getGroup ( int recId )

◆ Dictionary_ctor()

void Dictionary_ctor	(	Dictionary *const	me,
		DictEntry *	sto,
		uint32_t	capacity )

◆ Dictionary_config()

void Dictionary_config	(	Dictionary *const	me,
		int	keySize )

◆ Dictionary_at()

char const * Dictionary_at	(	Dictionary *const	me,
		unsigned	idx )

◆ Dictionary_put()

void Dictionary_put	(	Dictionary *const	me,
		KeyType	key,
		char const *	name )

◆ Dictionary_get()

char const * Dictionary_get	(	Dictionary *const	me,
		KeyType	key,
		char *	buf )

◆ Dictionary_find()

int Dictionary_find	(	Dictionary *const	me,
		KeyType	key )

◆ Dictionary_findKey()

KeyType Dictionary_findKey	(	Dictionary *const	me,
		char const *	name )

◆ Dictionary_reset()

void Dictionary_reset ( Dictionary *const me )

◆ SigDictionary_ctor()

void SigDictionary_ctor	(	SigDictionary *const	me,
		SigDictEntry *	sto,
		uint32_t	capacity )

◆ SigDictionary_config()

void SigDictionary_config	(	SigDictionary *const	me,
		int	ptrSize )

◆ SigDictionary_put()

void SigDictionary_put	(	SigDictionary *const	me,
		SigType	sig,
		ObjType	obj,
		char const *	name )

◆ SigDictionary_get()

char const * SigDictionary_get	(	SigDictionary *const	me,
		SigType	sig,
		ObjType	obj,
		char *	buf )

◆ SigDictionary_find()

int SigDictionary_find	(	SigDictionary *const	me,
		SigType	sig,
		ObjType	obj )

◆ SigDictionary_findSig()

SigType SigDictionary_findSig	(	SigDictionary *const	me,
		char const *	name,
		ObjType	obj )

◆ SigDictionary_reset()

void SigDictionary_reset ( SigDictionary *const me )

◆ QSPY_resetAllDictionaries()

void QSPY_resetAllDictionaries ( void )

Variable Documentation

◆ QSPY_output

QSPY_LastOutput QSPY_output

extern

◆ QSPY_line

char const* const QSPY_line

extern

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ QSPY_VER

◆ SIG_NOT_FOUND

◆ KEY_NOT_FOUND

◆ QS_LINE_OFFSET

◆ SNPRINTF_LINE

◆ SNPRINTF_APPEND

◆ CONFIG_UPDATE

Typedef Documentation

◆ QSignal

◆ QSPY_CustParseFun

◆ QSPY_resetFun

◆ KeyType

◆ SigType

◆ ObjType

Enumeration Type Documentation

◆ QSpyStatus

◆ anonymous enum

◆ anonymous enum

◆ QSPY_LastOutputType

◆ QSRreRecGroup

Function Documentation

◆ QSpyRecord_init()

◆ QSpyRecord_OK()

◆ QSpyRecord_getUint32()

◆ QSpyRecord_getInt32()

◆ QSpyRecord_getUint64()

◆ QSpyRecord_getInt64()

◆ QSpyRecord_getStr()

◆ QSpyRecord_getMem()

◆ QSPY_config()

◆ QSPY_configTxReset()

◆ QSPY_configMatFile()

◆ QSPY_reset()

◆ QSPY_parse()

◆ QSPY_txReset()

◆ QSPY_command()

◆ QSPY_sendEvt()

◆ QSPY_sendObj()

◆ QSPY_sendCmd()

◆ QSPY_sendTP()

◆ QSPY_showNote()

◆ QSPY_encode()

◆ QSPY_encodeResetCmd()

◆ QSPY_encodeInfoCmd()

◆ QSPY_encodeTickCmd()

◆ QSPY_findSig()

◆ QSPY_findObj()

◆ QSPY_findFun()

◆ QSPY_findUsr()

◆ QSPY_findEnum()

◆ QSPY_cleanup()

◆ QSPY_tstampStr()

◆ QSPY_onPrintLn()

◆ QSPY_printInfo()

◆ QSPY_printError()

◆ QSPY_getGroup()

◆ Dictionary_ctor()

◆ Dictionary_config()

◆ Dictionary_at()

◆ Dictionary_put()

◆ Dictionary_get()

◆ Dictionary_find()

◆ Dictionary_findKey()

◆ Dictionary_reset()

◆ SigDictionary_ctor()

◆ SigDictionary_config()

◆ SigDictionary_put()

◆ SigDictionary_get()

◆ SigDictionary_find()

◆ SigDictionary_findSig()

◆ SigDictionary_reset()

◆ QSPY_resetAllDictionaries()