MkKernel PACKAGE - a collection of common used data types and definitions … More...

Collaboration diagram for MkKernel_Type_C_API:

Classes
struct	MK_STRN_A
	array of MK_STRN values … More...

Macros
#define	MK_ALFA '@'
	MK_ALFA the command-line separator between server and client …

#define	MK_ALFA_STR ((MkStringR){1,"@"})
	MK_ALFA the command-line separator as string …

Typedefs
typedef void(*	MkMarkF) (MK_RT mkrt, MK_PTR data)
	prototype for a Garbage-Collection mark function …

boolean data-type
typedef unsigned char	MK_BOL
	1 byte boolean data-type

typedef bool	MK_BOOL
	real bool data-type

#define	bool2str(_bool)

signed integer data-type
typedef signed char	MK_I8
	1 byte byte data-type

typedef signed short int	MK_I16
	2 byte short data-type

typedef signed int	MK_I32
	4 byte integer data-type

typedef signed long long	MK_I64
	8 byte wide integer data-type

typedef long	MK_LONG
	4/8 byte long data-type

unsigned integer data-type
typedef unsigned char	MK_U8

typedef unsigned short	MK_U16

typedef unsigned int	MK_U32

typedef unsigned long long	MK_U64

typedef unsigned long	MK_ULN

float data-type
typedef float	MK_FLT
	4 byte float data-type

typedef double	MK_DBL
	8 byte double data-type

"handle" data-type
4 byte int handle data-type The handle is a special type to represent an object as numeric-type able to be stored into an external-software. The handle support the following API: MkObjectHandleGet → The conversion from an instance into a handle. MkObjectHandleResolve → The conversion from an handle into an instance. MkObjectHandleDelete → The handle is deleted. Future use of the same handle will generate an error.
typedef int32_t	MK_HDL
	4 byte int handle data-type

#define	MK_HDL_REF_S3(__prefix)

#define	MK_HDL_REF_S1(__prefix)

#define	MK_HDLT MK_I32T

misc data-type
typedef long	MK_SIZE

typedef union MkBufferAtomU	MK_ATO
	8 byte atom data-type

typedef int32_t	MK_NUM
	array size data-type ('num' items in array …

typedef int	MK_DBG
	debug-level data-type …

typedef unsigned int	MK_SIG
	signature datatype

#define	MK_FORMAT_N "%i"

OS wide MK_TIME_T
timeout in seconds as "integer" value
typedef time_t	MK_TIME_T

#define	MK_FORMAT_TIME "%li"

#define	MK_TIME ((MK_TIME_T)time(NULL))

#define	MK_TIME_MAX (3652460*60)
	one year

pointer data-type
typedef void	MK_PTRB
	pointer type data-type

typedef MK_PTRB *	MK_PTR
	generic pointer data-type

typedef const MK_PTRB *	MK_PTRN
	const generic pointer data-type

typedef MK_PTRB *	MK_CCP
	class constructor/destructor data type

typedef MK_PTRB *	MK_CBP
	generic pointer to call-back data

typedef MK_PTRB *	MK_MNG
	managed object pointer, datatype will be checked at runtime

typedef const MK_PTRB *	MK_MNGN
	const - a managed object pointer, datatype will be checked at runtime

typedef MK_PTRB const *	MK_EXP
	exception object pointer

typedef MK_PTRB *	MK_MXP
	MkExceptionC object pointer.

list data-type
typedef unsigned char	MK_LSTB
	list type data-type

typedef MK_LSTB *	MK_LST
	list pointer data-type

binary data-type
typedef unsigned char	MK_BINB
	byte-array type data-type

typedef MK_BINB *	MK_BIN
	byte-array pointer data-type with binary encoding (byte[])

typedef MK_BINB const *	MK_BINN
	const byte-array pointer data-type

primitive string data-type
typedef char	MK_STRB
	string type data-type

typedef MK_STRB *	MK_STR
	string pointer data-type with `UTF8` ecoding (String)

typedef const MK_STRB *	MK_STRN
	constant string pointer data-type

typedef MK_STRB const *	MK_FST
	const format string pointer data-type

MK_UNUSED static const MK_STRN_A	MK_STRN_A_NULL = (MK_STRN_A) {0,0}

helper type for target language implementation
typedef void *	MK_NAT_OBJECT

typedef void *	MK_NAT_LIST

Detailed Description

MkKernel PACKAGE - a collection of common used data types and definitions …

Macro Definition Documentation

◆ bool2str

#define bool2str ( _bool )

Value:

(_bool?"true":"false")

Definition at line 1181 of file LibMkKernel_mk.h.

◆ MK_ALFA

#define MK_ALFA '@'

MK_ALFA the command-line separator between server and client …

Definition at line 1164 of file LibMkKernel_mk.h.

◆ MK_ALFA_STR

#define MK_ALFA_STR ((MkStringR){1,"@"})

MK_ALFA the command-line separator as string …

Definition at line 1166 of file LibMkKernel_mk.h.

◆ MK_FORMAT_N

#define MK_FORMAT_N "%i"

Definition at line 1293 of file LibMkKernel_mk.h.

◆ MK_FORMAT_TIME

#define MK_FORMAT_TIME "%li"

Definition at line 1369 of file LibMkKernel_mk.h.

◆ MK_HDL_REF_S1

#define MK_HDL_REF_S1 ( __prefix )

Value:

__prefix ## I32

Definition at line 1267 of file LibMkKernel_mk.h.

◆ MK_HDL_REF_S3

#define MK_HDL_REF_S3 ( __prefix )

Value:

__prefix ## NI4

Definition at line 1266 of file LibMkKernel_mk.h.

◆ MK_HDLT

#define MK_HDLT MK_I32T

Definition at line 1268 of file LibMkKernel_mk.h.

◆ MK_TIME

#define MK_TIME ((MK_TIME_T)time(NULL))

Definition at line 1370 of file LibMkKernel_mk.h.

◆ MK_TIME_MAX

#define MK_TIME_MAX (365*24*60*60)

one year

Definition at line 1371 of file LibMkKernel_mk.h.

Typedef Documentation

◆ MK_ATO

typedef union MkBufferAtomU MK_ATO

8 byte atom data-type

Definition at line 1287 of file LibMkKernel_mk.h.

◆ MK_BIN

typedef MK_BINB* MK_BIN

byte-array pointer data-type with binary encoding (byte[])

Definition at line 1438 of file LibMkKernel_mk.h.

◆ MK_BINB

typedef unsigned char MK_BINB

byte-array type data-type

Definition at line 1434 of file LibMkKernel_mk.h.

◆ MK_BINN

typedef MK_BINB const* MK_BINN

const byte-array pointer data-type

Definition at line 1442 of file LibMkKernel_mk.h.

◆ MK_BOL

typedef unsigned char MK_BOL

1 byte boolean data-type

Definition at line 1175 of file LibMkKernel_mk.h.

◆ MK_BOOL

typedef bool MK_BOOL

real bool data-type

Definition at line 1180 of file LibMkKernel_mk.h.

◆ MK_CBP

typedef MK_PTRB* MK_CBP

generic pointer to call-back data

Definition at line 1396 of file LibMkKernel_mk.h.

◆ MK_CCP

typedef MK_PTRB* MK_CCP

class constructor/destructor data type

Definition at line 1393 of file LibMkKernel_mk.h.

◆ MK_DBG

typedef int MK_DBG

debug-level data-type …

Definition at line 1297 of file LibMkKernel_mk.h.

◆ MK_DBL

typedef double MK_DBL

8 byte double data-type

Definition at line 1243 of file LibMkKernel_mk.h.

◆ MK_EXP

typedef MK_PTRB const* MK_EXP

exception object pointer

Definition at line 1405 of file LibMkKernel_mk.h.

◆ MK_FLT

typedef float MK_FLT

4 byte float data-type

Definition at line 1240 of file LibMkKernel_mk.h.

◆ MK_FST

typedef MK_STRB const* MK_FST

const format string pointer data-type

Definition at line 1475 of file LibMkKernel_mk.h.

◆ MK_HDL

typedef int32_t MK_HDL

4 byte int handle data-type

The handle is a special type to represent an object as numeric-type able to be stored into an external-software.

The handle support the following API:

MkObjectHandleGet → The conversion from an instance into a handle.
MkObjectHandleResolve → The conversion from an handle into an instance.
MkObjectHandleDelete → The handle is deleted. Future use of the same handle will generate an error.

Definition at line 1265 of file LibMkKernel_mk.h.

◆ MK_I16

typedef signed short int MK_I16

2 byte short data-type

Definition at line 1195 of file LibMkKernel_mk.h.

◆ MK_I32

typedef signed int MK_I32

4 byte integer data-type

Definition at line 1198 of file LibMkKernel_mk.h.

◆ MK_I64

typedef signed long long MK_I64

8 byte wide integer data-type

Definition at line 1205 of file LibMkKernel_mk.h.

◆ MK_I8

typedef signed char MK_I8

1 byte byte data-type

Definition at line 1192 of file LibMkKernel_mk.h.

◆ MK_LONG

typedef long MK_LONG

4/8 byte long data-type

Definition at line 1210 of file LibMkKernel_mk.h.

◆ MK_LST

typedef MK_LSTB* MK_LST

list pointer data-type

Definition at line 1423 of file LibMkKernel_mk.h.

◆ MK_LSTB

typedef unsigned char MK_LSTB

list type data-type

Definition at line 1419 of file LibMkKernel_mk.h.

◆ MK_MNG

typedef MK_PTRB* MK_MNG

managed object pointer, datatype will be checked at runtime

Definition at line 1399 of file LibMkKernel_mk.h.

◆ MK_MNGN

typedef const MK_PTRB* MK_MNGN

const - a managed object pointer, datatype will be checked at runtime

Definition at line 1402 of file LibMkKernel_mk.h.

◆ MK_MXP

typedef MK_PTRB* MK_MXP

MkExceptionC object pointer.

Definition at line 1408 of file LibMkKernel_mk.h.

◆ MK_NAT_LIST

typedef void* MK_NAT_LIST

Definition at line 1486 of file LibMkKernel_mk.h.

◆ MK_NAT_OBJECT

typedef void* MK_NAT_OBJECT

Definition at line 1484 of file LibMkKernel_mk.h.

◆ MK_NUM

typedef int32_t MK_NUM

array size data-type ('num' items in array …

Attention: -> need signed integer in pBusReadNextWord -> need int because of pSwapI in pReadHDR

Definition at line 1292 of file LibMkKernel_mk.h.

◆ MK_PTR

typedef MK_PTRB* MK_PTR

generic pointer data-type

Definition at line 1387 of file LibMkKernel_mk.h.

◆ MK_PTRB

typedef void MK_PTRB

pointer type data-type

Definition at line 1383 of file LibMkKernel_mk.h.

◆ MK_PTRN

typedef const MK_PTRB* MK_PTRN

const generic pointer data-type

Definition at line 1390 of file LibMkKernel_mk.h.

◆ MK_SIG

typedef unsigned int MK_SIG

signature datatype

The MOT-class is identified by a signature and a mask.

The signature and the mask are an 32bit unsigned integer value of type MK_SIG.

The signature and the mask define the MOT-class and the class-hierarchie.
The signature and the mask are created by the CLASS-TOOL and written into the class-def-source-code.
#define MkBufferC_SIGNATURE (MkObjectC_SIGNATURE ^ (1u<<10))

#define MkBufferC_MASK (((1u<<22)-1)<<10)

The class-type is the storage for the signature and the mask

The signature is stored in the (MkTypeS::objsig) entry of the MkTypeS class-type.
The mask is stored in the (MkTypeS::objmask) entry of the MkTypeS class-type.
The class-type is initialized at runtime-startup.
MkInstanceTypeInit ( MkBufferC, MkObjectC ) ;

MkTYP_R(MkBufferST).destructor = (MkDestructorF) MkBufferDelete_RT ;

MkTYP_R(MkBufferST).dup = (MkDupF) MkBufferDup_RT ;

MkTYP_R(MkBufferST).merge = (MkMergeF) MkBufferMerge_RT ;

MkTYP_R(MkBufferST).copy = (MkCopyF) MkBufferCopy_RT ;

MkTYP_R(MkBufferST).reset = (MkResetF) MkBufferReset_RT ;

MkTYP_R(MkBufferST).log = (MkLogF) MkBufferLog_RT ;

MkTYP_R(MkBufferST).toString = (MkToStringF) MkBufferToString_RT ;

...
#define MkInstanceTypeInit(cls,bse) MkInstanceTypeInit_4(cls,((RT_REF)._##cls##_T),bse,#cls)

...
#define MkInstanceTypeInit_4(_cls,_typ,_bse,_nme) do { \

MkTypeInit_4(_cls,_typ,_bse,_nme); \

(*_cls##_TT).objsig = _cls##_SIGNATURE ; \

(*_cls##_TT).objmask = _cls##_MASK ; \

(*_cls##_TT).objsize = sizeof (_cls##R) ; \

} while (0)

The instance-type is initialized by the class-type

The instance-signature stored at instance.super.obj.signature.
- The instance.super.obj.signature is the MkObjectS::signature attribute of the MkObjectS instance-type.
- Every pointer to the instance is also a pointer to the instance.super.obj.signature.
The instance-signature is initialized from MkTypeS::objsig.
#define MkObjInitFromType(typeV,isLocalV) \

MkObjInit2(MK_RT_PTR, NULL, (*typeV).objsig, typeV, 0, isLocalV)

...
#define MkObjInit2(rtmkV,rtExtV,sigV,typeV,refCountV,isLocalV) \

(struct MkObjectS) { \

.signature = sigV, \

.refCount = refCountV, \

.self = NULL, \

.type = typeV, \

.env = NULL, \

.selfCreated = false, \

.selfRefCount = 0, \

.objRt = rtmkV, \

.objRtExt = rtExtV, \

.obj_protect = { \

.isLocal = isLocalV, \

.prev = NULL, \

.next = NULL, \

}, \

}

The signature check is done at runtime with MyClassC_Check(instancePtr) (example: MkBufferC_Check).

The test is true if the instance belongs to the class MyClassC or has MyClassC as base-class.

To check an instance on the instance-type without instance-base use:

switch (obj->signature) {

case LcConfigC_SIGNATURE: ...; break;

case LcSettingC_SIGNATURE: ...; break;

default: ...; break;

}

To check an instance on the instance-type and instance-base use:

if (LcConfigC_Check(obj) {

...

} else if (LcSettingC_Check(obj)) {

...

} else {

...

}

Definition at line 1358 of file LibMkKernel_mk.h.

◆ MK_SIZE

typedef long MK_SIZE

Definition at line 1284 of file LibMkKernel_mk.h.

◆ MK_STR

typedef MK_STRB* MK_STR

string pointer data-type with UTF8 ecoding (String)

Definition at line 1457 of file LibMkKernel_mk.h.

◆ MK_STRB

typedef char MK_STRB

string type data-type

Definition at line 1453 of file LibMkKernel_mk.h.

◆ MK_STRN

typedef const MK_STRB* MK_STRN

constant string pointer data-type

Definition at line 1461 of file LibMkKernel_mk.h.

◆ MK_TIME_T

typedef time_t MK_TIME_T

Definition at line 1368 of file LibMkKernel_mk.h.

◆ MK_U16

typedef unsigned short MK_U16

Definition at line 1222 of file LibMkKernel_mk.h.

◆ MK_U32

typedef unsigned int MK_U32

Definition at line 1224 of file LibMkKernel_mk.h.

◆ MK_U64

typedef unsigned long long MK_U64

Definition at line 1226 of file LibMkKernel_mk.h.

◆ MK_U8

typedef unsigned char MK_U8

Definition at line 1220 of file LibMkKernel_mk.h.

◆ MK_ULN

typedef unsigned long MK_ULN

Definition at line 1230 of file LibMkKernel_mk.h.

◆ MkMarkF

typedef void( * MkMarkF) (MK_RT mkrt,MK_PTR data)

prototype for a Garbage-Collection mark function …

Definition at line 2348 of file LibMkKernel_mk.h.

Variable Documentation

◆ MK_STRN_A_NULL

MK_UNUSED static const MK_STRN_A MK_STRN_A_NULL = (MK_STRN_A) {0,0}

static

Definition at line 1471 of file LibMkKernel_mk.h.

1471{0,0};

Classes

Macros

Typedefs

boolean data-type

signed integer data-type

unsigned integer data-type

float data-type

"handle" data-type

misc data-type

OS wide MK_TIME_T

pointer data-type

list data-type

binary data-type

primitive string data-type

helper type for target language implementation

Detailed Description

Macro Definition Documentation

◆ bool2str

◆ MK_ALFA

◆ MK_ALFA_STR

◆ MK_FORMAT_N

◆ MK_FORMAT_TIME

◆ MK_HDL_REF_S1

◆ MK_HDL_REF_S3

◆ MK_HDLT

◆ MK_TIME

◆ MK_TIME_MAX

Typedef Documentation

◆ MK_ATO

◆ MK_BIN

◆ MK_BINB

◆ MK_BINN

◆ MK_BOL

◆ MK_BOOL

◆ MK_CBP

◆ MK_CCP

◆ MK_DBG

◆ MK_DBL

◆ MK_EXP

◆ MK_FLT

◆ MK_FST

◆ MK_HDL

◆ MK_I16

◆ MK_I32

◆ MK_I64

◆ MK_I8

◆ MK_LONG

◆ MK_LST

◆ MK_LSTB

◆ MK_MNG

◆ MK_MNGN

◆ MK_MXP

◆ MK_NAT_LIST

◆ MK_NAT_OBJECT

◆ MK_NUM

◆ MK_PTR

◆ MK_PTRB

◆ MK_PTRN

◆ MK_SIG

◆ MK_SIZE

◆ MK_STR

◆ MK_STRB

◆ MK_STRN

◆ MK_TIME_T

◆ MK_U16

◆ MK_U32

◆ MK_U64

◆ MK_U8

◆ MK_ULN

◆ MkMarkF

Variable Documentation

◆ MK_STRN_A_NULL