MkBufferC - various functions to create, initialize and destroy a MkBufferC … More...

Collaboration diagram for MkBufferC_TOR_C_API:

Macros
#define	MkBufferCreateTLS_T(cls, name, size)
	create an new MkBufferC object as T)hread L)ocal S)torage…

#define	MkBufferCreateTLS_inout_T(cls, name, inout)
	Constructs a MkBufferC instance as T)hread L)ocal S)torage OR reuse inout if possible…

#define	MkBufferCreateLOCAL_T(cls, name, size)
	create an new MkBufferC object as L)ocal S)torage…

Functions
MK_EXTERN MK_BUF	MkBufferCreate_RT (MK_RT mkrt, MK_TYP type, MK_NUM const size)
	Constructor - create a new MkBufferC with minimum size of internal storage …

MK_EXTERN MK_BUF	MkBufferCreate64_RT (MK_RT mkrt, MK_NUM const size)
	call the BufferCreate with default type MkBuffer64S (64 byte) …

MK_EXTERN MK_BUF	MkBufferCreate256_RT (MK_RT mkrt, MK_NUM const size)
	call the BufferCreate with default type MkBuffer256S (256 byte) …

MK_EXTERN MK_BUF	MkBufferCreate1024_RT (MK_RT mkrt, MK_NUM const size)
	call the BufferCreate with default type MkBuffer1024S (1024 byte) …

void	MkBufferCreateTLS_T (MK_MACRO_TYP cls, MK_MACRO_TYP name, MK_NUM const size)

void	MkBufferCreateTLS_inout_T (MK_MACRO_TYP cls, MK_MACRO_TYP name, MK_BUF *inout)

void	MkBufferCreateLOCAL_T (MK_MACRO_TYP cls, MK_MACRO_TYP name, MK_NUM const size)

MK_EXTERN MK_BUF	MkBufferCreateI8_RT (MK_RT mkrt, MK_I8 const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateBOL_RT (MK_RT mkrt, MK_BOL const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateI16_RT (MK_RT mkrt, MK_I16 const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateI32_RT (MK_RT mkrt, MK_I32 const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateFLT_RT (MK_RT mkrt, MK_FLT const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateI64_RT (MK_RT mkrt, MK_I64 const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateDBL_RT (MK_RT mkrt, MK_DBL const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateSTR_RT (MK_RT mkrt, MK_STRN const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateBIN_RT (MK_RT mkrt, MkBinaryR const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN MK_BUF	MkBufferCreateTLS_RT (MK_RT mkrt, MK_STRN const tlsName, bool const resetB)
	same as BufferCreate but require no cleanup

MK_EXTERN MK_BUF	MkBufferCreateBUF_RT (MK_RT mkrt, MK_BUFN const val)
	Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

MK_EXTERN void	MkBufferFree_RT (MK_RT mkrt, MK_BUF const buf)
	initialize or free an MkBufferC reference-instance …

MK_EXTERN void	MkBufferInit_RT (MK_RT mkrt, MK_BUF const buf, MK_TYP type, MK_NUM const size)
	initialize or free an MkBufferC reference-instance …

MK_EXTERN void	MkBufferDelete_RT (MK_RT mkrt, MK_BUF const buf)
	Destructor - delete a MkBufferC instance …

MK_EXTERN MK_BUF	MkBufferDup_RT (MK_RT mkrt, MK_BUFN const buf)
	Dup-Constructor - create a new MkBufferC instance as copy from an existing MkBufferC instance

MK_EXTERN MK_BUF	MkBufferMerge_RT (MK_RT mkrt, MK_BUF const buf)
	Merge-Constructor - create a new MkBufferC as a merge from an existing object …

MkBufferC - MkBufferC_TOR_C_API - overload
#define	MkBufferMerge_NULL(...)

#define	MkBufferMerge(...)

#define	MkBufferDup_NULL(...)

#define	MkBufferDup(...)

#define	MkBufferCreate_NULL(...)

#define	MkBufferCreate(...)

#define	MkBufferCreate_1(size)

#define	MkBufferCreate_0()

#define	MkBufferCreate1024_NULL(...)

#define	MkBufferCreate1024(...)

#define	MkBufferCreate1024_0()

#define	MkBufferCreate256_NULL(...)

#define	MkBufferCreate256(...)

#define	MkBufferCreate256_0()

#define	MkBufferCreate64_NULL(...)

#define	MkBufferCreate64(...)

#define	MkBufferCreate64_0()

#define	MkBufferCreateBIN_NULL(...)

#define	MkBufferCreateBIN(...)

#define	MkBufferCreateBOL_NULL(...)

#define	MkBufferCreateBOL(...)

#define	MkBufferCreateBUF_NULL(...)

#define	MkBufferCreateBUF(...)

#define	MkBufferCreateDBL_NULL(...)

#define	MkBufferCreateDBL(...)

#define	MkBufferCreateFLT_NULL(...)

#define	MkBufferCreateFLT(...)

#define	MkBufferCreateI16_NULL(...)

#define	MkBufferCreateI16(...)

#define	MkBufferCreateI32_NULL(...)

#define	MkBufferCreateI32(...)

#define	MkBufferCreateI64_NULL(...)

#define	MkBufferCreateI64(...)

#define	MkBufferCreateI8_NULL(...)

#define	MkBufferCreateI8(...)

#define	MkBufferCreateSTR_NULL(...)

#define	MkBufferCreateSTR(...)

#define	MkBufferDelete(x)

#define	MkBufferCreateTLS_NULL(...)

#define	MkBufferCreateTLS(...)

#define	MkBufferCreateTLS_1(tlsName)

#define	MkBufferFree_NULL(...)

#define	MkBufferFree(...)

#define	MkBufferInit_NULL(...)

#define	MkBufferInit(...)

#define	MkBufferInit_2(buf, size)

#define	MkBufferInit_1(buf)

Detailed Description

MkBufferC - various functions to create, initialize and destroy a MkBufferC …

Macro Definition Documentation

◆ MkBufferCreate

#define MkBufferCreate ( ... )

Value:

MkBufferCreate_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreate_RT

MK_EXTERN MK_BUF MkBufferCreate_RT(MK_RT mkrt, MK_TYP type, MK_NUM const size)

Constructor - create a new MkBufferC with minimum size of internal storage …

MK_RT_CALL

#define MK_RT_CALL

Definition LibMkKernel_mk.h:766

Definition at line 282 of file kernel_overload_mk.h.

◆ MkBufferCreate1024

#define MkBufferCreate1024 ( ... )

Value:

MkBufferCreate1024_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreate1024_RT

MK_EXTERN MK_BUF MkBufferCreate1024_RT(MK_RT mkrt, MK_NUM const size)

call the BufferCreate with default type MkBuffer1024S (1024 byte) …

Definition at line 286 of file kernel_overload_mk.h.

◆ MkBufferCreate1024_0

#define MkBufferCreate1024_0 ( )

Value:

MkBufferCreate1024(0)

MkBufferCreate1024

#define MkBufferCreate1024(...)

Definition kernel_overload_mk.h:286

Definition at line 287 of file kernel_overload_mk.h.

◆ MkBufferCreate1024_NULL

#define MkBufferCreate1024_NULL ( ... )

Value:

MkBufferCreate1024_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition LibMkKernel_mk.h:770

Definition at line 285 of file kernel_overload_mk.h.

◆ MkBufferCreate256

#define MkBufferCreate256 ( ... )

Value:

MkBufferCreate256_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreate256_RT

MK_EXTERN MK_BUF MkBufferCreate256_RT(MK_RT mkrt, MK_NUM const size)

call the BufferCreate with default type MkBuffer256S (256 byte) …

Definition at line 289 of file kernel_overload_mk.h.

◆ MkBufferCreate256_0

#define MkBufferCreate256_0 ( )

Value:

MkBufferCreate256(0)

MkBufferCreate256

#define MkBufferCreate256(...)

Definition kernel_overload_mk.h:289

Definition at line 290 of file kernel_overload_mk.h.

◆ MkBufferCreate256_NULL

#define MkBufferCreate256_NULL ( ... )

Value:

MkBufferCreate256_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 288 of file kernel_overload_mk.h.

◆ MkBufferCreate64

#define MkBufferCreate64 ( ... )

Value:

MkBufferCreate64_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreate64_RT

MK_EXTERN MK_BUF MkBufferCreate64_RT(MK_RT mkrt, MK_NUM const size)

call the BufferCreate with default type MkBuffer64S (64 byte) …

Definition at line 292 of file kernel_overload_mk.h.

◆ MkBufferCreate64_0

#define MkBufferCreate64_0 ( )

Value:

MkBufferCreate64(0)

MkBufferCreate64

#define MkBufferCreate64(...)

Definition kernel_overload_mk.h:292

Definition at line 293 of file kernel_overload_mk.h.

◆ MkBufferCreate64_NULL

#define MkBufferCreate64_NULL ( ... )

Value:

MkBufferCreate64_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 291 of file kernel_overload_mk.h.

◆ MkBufferCreate_0

#define MkBufferCreate_0 ( )

Value:

MkBufferCreate(NULL,0)

MkBufferCreate

#define MkBufferCreate(...)

Definition kernel_overload_mk.h:282

Definition at line 284 of file kernel_overload_mk.h.

◆ MkBufferCreate_1

#define MkBufferCreate_1 ( size )

Value:

MkBufferCreate(NULL,size)

Definition at line 283 of file kernel_overload_mk.h.

◆ MkBufferCreate_NULL

#define MkBufferCreate_NULL ( ... )

Value:

MkBufferCreate_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 281 of file kernel_overload_mk.h.

◆ MkBufferCreateBIN

#define MkBufferCreateBIN ( ... )

Value:

MkBufferCreateBIN_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateBIN_RT

MK_EXTERN MK_BUF MkBufferCreateBIN_RT(MK_RT mkrt, MkBinaryR const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 295 of file kernel_overload_mk.h.

◆ MkBufferCreateBIN_NULL

#define MkBufferCreateBIN_NULL ( ... )

Value:

MkBufferCreateBIN_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 294 of file kernel_overload_mk.h.

◆ MkBufferCreateBOL

#define MkBufferCreateBOL ( ... )

Value:

MkBufferCreateBOL_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateBOL_RT

MK_EXTERN MK_BUF MkBufferCreateBOL_RT(MK_RT mkrt, MK_BOL const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 297 of file kernel_overload_mk.h.

◆ MkBufferCreateBOL_NULL

#define MkBufferCreateBOL_NULL ( ... )

Value:

MkBufferCreateBOL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 296 of file kernel_overload_mk.h.

◆ MkBufferCreateBUF

#define MkBufferCreateBUF ( ... )

Value:

MkBufferCreateBUF_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateBUF_RT

MK_EXTERN MK_BUF MkBufferCreateBUF_RT(MK_RT mkrt, MK_BUFN const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 299 of file kernel_overload_mk.h.

◆ MkBufferCreateBUF_NULL

#define MkBufferCreateBUF_NULL ( ... )

Value:

MkBufferCreateBUF_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 298 of file kernel_overload_mk.h.

◆ MkBufferCreateDBL

#define MkBufferCreateDBL ( ... )

Value:

MkBufferCreateDBL_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateDBL_RT

MK_EXTERN MK_BUF MkBufferCreateDBL_RT(MK_RT mkrt, MK_DBL const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 301 of file kernel_overload_mk.h.

◆ MkBufferCreateDBL_NULL

#define MkBufferCreateDBL_NULL ( ... )

Value:

MkBufferCreateDBL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 300 of file kernel_overload_mk.h.

◆ MkBufferCreateFLT

#define MkBufferCreateFLT ( ... )

Value:

MkBufferCreateFLT_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateFLT_RT

MK_EXTERN MK_BUF MkBufferCreateFLT_RT(MK_RT mkrt, MK_FLT const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 303 of file kernel_overload_mk.h.

◆ MkBufferCreateFLT_NULL

#define MkBufferCreateFLT_NULL ( ... )

Value:

MkBufferCreateFLT_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 302 of file kernel_overload_mk.h.

◆ MkBufferCreateI16

#define MkBufferCreateI16 ( ... )

Value:

MkBufferCreateI16_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateI16_RT

MK_EXTERN MK_BUF MkBufferCreateI16_RT(MK_RT mkrt, MK_I16 const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 305 of file kernel_overload_mk.h.

◆ MkBufferCreateI16_NULL

#define MkBufferCreateI16_NULL ( ... )

Value:

MkBufferCreateI16_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 304 of file kernel_overload_mk.h.

◆ MkBufferCreateI32

#define MkBufferCreateI32 ( ... )

Value:

MkBufferCreateI32_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateI32_RT

MK_EXTERN MK_BUF MkBufferCreateI32_RT(MK_RT mkrt, MK_I32 const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 307 of file kernel_overload_mk.h.

◆ MkBufferCreateI32_NULL

#define MkBufferCreateI32_NULL ( ... )

Value:

MkBufferCreateI32_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 306 of file kernel_overload_mk.h.

◆ MkBufferCreateI64

#define MkBufferCreateI64 ( ... )

Value:

MkBufferCreateI64_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateI64_RT

MK_EXTERN MK_BUF MkBufferCreateI64_RT(MK_RT mkrt, MK_I64 const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 309 of file kernel_overload_mk.h.

◆ MkBufferCreateI64_NULL

#define MkBufferCreateI64_NULL ( ... )

Value:

MkBufferCreateI64_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 308 of file kernel_overload_mk.h.

◆ MkBufferCreateI8

#define MkBufferCreateI8 ( ... )

Value:

MkBufferCreateI8_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateI8_RT

MK_EXTERN MK_BUF MkBufferCreateI8_RT(MK_RT mkrt, MK_I8 const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 311 of file kernel_overload_mk.h.

◆ MkBufferCreateI8_NULL

#define MkBufferCreateI8_NULL ( ... )

Value:

MkBufferCreateI8_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 310 of file kernel_overload_mk.h.

◆ MkBufferCreateLOCAL_T

#define MkBufferCreateLOCAL_T	(	cls,
		name,
		size )

Value:

  cls##R name##R = {0};                             \
  struct MkBufferS * const name = MkBUF(&name##R);  \
  MkBufferInit(name,cls##_TT,size)

create an new MkBufferC object as L)ocal S)torage…

The cls argument is: MkBuffer64S 64 bytes, MkBuffer256S = 256 bytes, MkBuffer1024S = 1024 bytes,

hint: access string with bufR.super.buf.storage.first.C

Parameters

[in]	cls	A subclass of MkBufferS with predefined ILS storage → MkBuffer64S, MkBuffer256S and MkBuffer1024S
	name	the name of the new MkBufferC
	size	the initial size of the new MkBufferC

#define MkBufferCreateLOCAL_T(cls,name,size)        \
  cls##R name##R = {0};                             \
  struct MkBufferS * const name = MkBUF(&name##R);  \
  MkBufferInit(name,cls##_TT,size)

Definition at line 6128 of file LibMkKernel_mk.h.

#define MkBufferCreateLOCAL_T(cls,name,size)        \
  cls##R name##R = {0};                             \
  struct MkBufferS * const name = MkBUF(&name##R);  \
  MkBufferInit(name,cls##_TT,size)

◆ MkBufferCreateSTR

#define MkBufferCreateSTR ( ... )

Value:

MkBufferCreateSTR_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateSTR_RT

MK_EXTERN MK_BUF MkBufferCreateSTR_RT(MK_RT mkrt, MK_STRN const val)

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

Definition at line 313 of file kernel_overload_mk.h.

◆ MkBufferCreateSTR_NULL

#define MkBufferCreateSTR_NULL ( ... )

Value:

MkBufferCreateSTR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 312 of file kernel_overload_mk.h.

◆ MkBufferCreateTLS

#define MkBufferCreateTLS ( ... )

Value:

MkBufferCreateTLS_RT(MK_RT_CALL __VA_ARGS__)

MkBufferCreateTLS_RT

MK_EXTERN MK_BUF MkBufferCreateTLS_RT(MK_RT mkrt, MK_STRN const tlsName, bool const resetB)

same as BufferCreate but require no cleanup

Definition at line 320 of file kernel_overload_mk.h.

◆ MkBufferCreateTLS_1

#define MkBufferCreateTLS_1 ( tlsName )

Value:

MkBufferCreateTLS(tlsName,true)

MkBufferCreateTLS

#define MkBufferCreateTLS(...)

Definition kernel_overload_mk.h:320

Definition at line 321 of file kernel_overload_mk.h.

◆ MkBufferCreateTLS_inout_T

#define MkBufferCreateTLS_inout_T	(	cls,
		name,
		inout )

Value:

  static MkThreadLocal struct MkBufferS __hidden_##name##R = {0};    \
  MK_BUF name = *inout != NULL ? *inout : &__hidden_##name##R;       \
  if (likely(!__MkCheckX(MkBufferC,name))) {                         \
    MkBufferInit(name,cls##_TT,0);                                   \
    MkRefIncr_1X(name);                                              \
  } else if (name->var.cursize) {                                    \
    MkBufferReset(name);                                             \
  }                                                                  \

Constructs a MkBufferC instance as T)hread L)ocal S)torage OR reuse inout if possible…

Same as MkBufferCreateTLS_T but try to reuse an already existsing inout. If inout is a MK_NULL pointer than a pointer to a local-reference is returned.

#define MkBufferCreateTLS_inout_T(cls,name,inout)                    \
  static MkThreadLocal struct MkBufferS __hidden_##name##R = {0};    \
  MK_BUF name = *inout != NULL ? *inout : &__hidden_##name##R;       \
  if (likely(!__MkCheckX(MkBufferC,name))) {                         \
    MkBufferInit(name,cls##_TT,0);                                   \
    MkRefIncr_1X(name);                                              \
  } else if (name->var.cursize) {                                    \
    MkBufferReset(name);                                             \
  }                                                                  \

Definition at line 6101 of file LibMkKernel_mk.h.

#define MkBufferCreateTLS_inout_T(cls,name,inout)                    \
  static MkThreadLocal struct MkBufferS __hidden_##name##R = {0};    \
  MK_BUF name = *inout != NULL ? *inout : &__hidden_##name##R;       \
  if (likely(!__MkCheckX(MkBufferC,name))) {                         \
    MkBufferInit(name,cls##_TT,0);                                   \
    MkRefIncr_1X(name);                                              \
  } else if (name->var.cursize) {                                    \
    MkBufferReset(name);                                             \
  }                                                                  \
// [MkBufferCreateTLS_inout_T]

◆ MkBufferCreateTLS_NULL

#define MkBufferCreateTLS_NULL ( ... )

Value:

MkBufferCreateTLS_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 319 of file kernel_overload_mk.h.

◆ MkBufferCreateTLS_T

#define MkBufferCreateTLS_T	(	cls,
		name,
		size )

Value:

  static MkThreadLocal cls##R name##R = {0};        \
  MK_BUF name = MkBUF(&name##R);                    \
  if (unlikely(!__MkCheckX(cls,&name##R))) {        \
    MkBufferInit(name,cls##_TT,size);               \
    MkRefIncr_1X(name);                             \
  } else if (MkBUF_R(&name##R).var.cursize) {       \
    MkBufferReset(name);                            \
  }

create an new MkBufferC object as T)hread L)ocal S)torage…

The cls argument is: MkBuffer64S 64 bytes, MkBuffer256S = 256 bytes, MkBuffer1024S = 1024 bytes,

Parameters

[in]	cls	A subclass of MkBufferS with predefined ILS storage → MkBuffer64S, MkBuffer256S and MkBuffer1024S
	name	the name of the new MkBufferC
	size	the initial size of the new MkBufferC

Note: This function is intended as a replacement for MkBufferCreateTLS for the C programming language.

#define MkBufferCreateTLS_T(cls,name,size)          \
  static MkThreadLocal cls##R name##R = {0};        \
  MK_BUF name = MkBUF(&name##R);                    \
  if (unlikely(!__MkCheckX(cls,&name##R))) {        \
    MkBufferInit(name,cls##_TT,size);               \
    MkRefIncr_1X(name);                             \
  } else if (MkBUF_R(&name##R).var.cursize) {       \
    MkBufferReset(name);                            \
  }

Definition at line 6081 of file LibMkKernel_mk.h.

#define MkBufferCreateTLS_T(cls,name,size)          \
  static MkThreadLocal cls##R name##R = {0};        \
  MK_BUF name = MkBUF(&name##R);                    \
  if (unlikely(!__MkCheckX(cls,&name##R))) {        \
    MkBufferInit(name,cls##_TT,size);               \
    MkRefIncr_1X(name);                             \
  } else if (MkBUF_R(&name##R).var.cursize) {       \
    MkBufferReset(name);                            \
  }

◆ MkBufferDelete

#define MkBufferDelete ( x )

Value:

MkObjectDeleteToNull(MkBufferDelete_RT,MK,x)

MkBufferDelete_RT

MK_EXTERN void MkBufferDelete_RT(MK_RT mkrt, MK_BUF const buf)

Destructor - delete a MkBufferC instance …

MkObjectDeleteToNull

#define MkObjectDeleteToNull(fct, NS, x)

Definition LibMkKernel_mk.h:4047

Definition at line 316 of file kernel_overload_mk.h.

◆ MkBufferDup

#define MkBufferDup ( ... )

Value:

MkBufferDup_RT(MK_RT_CALL __VA_ARGS__)

MkBufferDup_RT

MK_EXTERN MK_BUF MkBufferDup_RT(MK_RT mkrt, MK_BUFN const buf)

Dup-Constructor - create a new MkBufferC instance as copy from an existing MkBufferC instance

Definition at line 278 of file kernel_overload_mk.h.

◆ MkBufferDup_NULL

#define MkBufferDup_NULL ( ... )

Value:

MkBufferDup_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 277 of file kernel_overload_mk.h.

◆ MkBufferFree

#define MkBufferFree ( ... )

Value:

MkBufferFree_RT(MK_RT_CALL __VA_ARGS__)

MkBufferFree_RT

MK_EXTERN void MkBufferFree_RT(MK_RT mkrt, MK_BUF const buf)

initialize or free an MkBufferC reference-instance …

Definition at line 325 of file kernel_overload_mk.h.

◆ MkBufferFree_NULL

#define MkBufferFree_NULL ( ... )

Value:

MkBufferFree_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 324 of file kernel_overload_mk.h.

◆ MkBufferInit

#define MkBufferInit ( ... )

Value:

MkBufferInit_RT(MK_RT_CALL __VA_ARGS__)

MkBufferInit_RT

MK_EXTERN void MkBufferInit_RT(MK_RT mkrt, MK_BUF const buf, MK_TYP type, MK_NUM const size)

initialize or free an MkBufferC reference-instance …

Definition at line 327 of file kernel_overload_mk.h.

◆ MkBufferInit_1

#define MkBufferInit_1 ( buf )

Value:

MkBufferInit(buf,NULL,0)

MkBufferInit

#define MkBufferInit(...)

Definition kernel_overload_mk.h:327

Definition at line 329 of file kernel_overload_mk.h.

◆ MkBufferInit_2

#define MkBufferInit_2	(		buf,
			size )

Value:

MkBufferInit(buf,NULL,size)

Definition at line 328 of file kernel_overload_mk.h.

◆ MkBufferInit_NULL

#define MkBufferInit_NULL ( ... )

Value:

MkBufferInit_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 326 of file kernel_overload_mk.h.

◆ MkBufferMerge

#define MkBufferMerge ( ... )

Value:

MkBufferMerge_RT(MK_RT_CALL __VA_ARGS__)

MkBufferMerge_RT

MK_EXTERN MK_BUF MkBufferMerge_RT(MK_RT mkrt, MK_BUF const buf)

Merge-Constructor - create a new MkBufferC as a merge from an existing object …

Definition at line 274 of file kernel_overload_mk.h.

◆ MkBufferMerge_NULL

#define MkBufferMerge_NULL ( ... )

Value:

MkBufferMerge_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 273 of file kernel_overload_mk.h.

Function Documentation

◆ MkBufferCreate1024_RT()

MK_EXTERN MK_BUF MkBufferCreate1024_RT	(	MK_RT	mkrt,
		MK_NUM const	size )

call the BufferCreate with default type MkBuffer1024S (1024 byte) …

◆ MkBufferCreate256_RT()

MK_EXTERN MK_BUF MkBufferCreate256_RT	(	MK_RT	mkrt,
		MK_NUM const	size )

call the BufferCreate with default type MkBuffer256S (256 byte) …

◆ MkBufferCreate64_RT()

MK_EXTERN MK_BUF MkBufferCreate64_RT	(	MK_RT	mkrt,
		MK_NUM const	size )

call the BufferCreate with default type MkBuffer64S (64 byte) …

◆ MkBufferCreate_RT()

MK_EXTERN MK_BUF MkBufferCreate_RT	(	MK_RT	mkrt,
		MK_TYP	type,
		MK_NUM const	size )

Constructor - create a new MkBufferC with minimum size of internal storage …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

There is a MkBufferCreateTT function for every PRIMITIVE TYPE.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	type	A type defined as MkTypeS with a TT postfix (default: MkBuffer64S, possible: MkBuffer64S, MkBuffer256S and MkBuffer1024S)
[in]	size	The initial size of the instance-local-storage. The MkBufferC has dynamic-memory-management, the size value is just a hint to provide enought memory for future tasks. The real size created is the maximum of type-ILS-size and size . (default: 0 = use the type-ILS-size)

Returns: The newly created MkBufferC instance, the instance is owned by the caller

See also: BufferDelete BufferDup MqReadBUF

◆ MkBufferCreateBIN_RT()

MK_EXTERN MK_BUF MkBufferCreateBIN_RT	(	MK_RT	mkrt,
		MkBinaryR const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateBOL_RT()

MK_EXTERN MK_BUF MkBufferCreateBOL_RT	(	MK_RT	mkrt,
		MK_BOL const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateBUF_RT()

MK_EXTERN MK_BUF MkBufferCreateBUF_RT	(	MK_RT	mkrt,
		MK_BUFN const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateDBL_RT()

MK_EXTERN MK_BUF MkBufferCreateDBL_RT	(	MK_RT	mkrt,
		MK_DBL const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateFLT_RT()

MK_EXTERN MK_BUF MkBufferCreateFLT_RT	(	MK_RT	mkrt,
		MK_FLT const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateI16_RT()

MK_EXTERN MK_BUF MkBufferCreateI16_RT	(	MK_RT	mkrt,
		MK_I16 const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateI32_RT()

MK_EXTERN MK_BUF MkBufferCreateI32_RT	(	MK_RT	mkrt,
		MK_I32 const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateI64_RT()

MK_EXTERN MK_BUF MkBufferCreateI64_RT	(	MK_RT	mkrt,
		MK_I64 const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateI8_RT()

MK_EXTERN MK_BUF MkBufferCreateI8_RT	(	MK_RT	mkrt,
		MK_I8 const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateLOCAL_T()

void MkBufferCreateLOCAL_T	(	MK_MACRO_TYP	cls,
		MK_MACRO_TYP	name,
		MK_NUM const	size )

◆ MkBufferCreateSTR_RT()

MK_EXTERN MK_BUF MkBufferCreateSTR_RT	(	MK_RT	mkrt,
		MK_STRN const	val )

Constructor - create a new MkBufferC with an PRIMITIVE TYPE …

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Returns: The newly created MkBufferC instance, the instance is owned by the caller

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	the PRIMITIVE TYPE object as data-source

◆ MkBufferCreateTLS_inout_T()

void MkBufferCreateTLS_inout_T	(	MK_MACRO_TYP	cls,
		MK_MACRO_TYP	name,
		MK_BUF *	inout )

◆ MkBufferCreateTLS_RT()

MK_EXTERN MK_BUF MkBufferCreateTLS_RT	(	MK_RT	mkrt,
		MK_STRN const	tlsName,
		bool const	resetB )

same as BufferCreate but require no cleanup

A TLS-instance only exists ONCE per thread and ONCE per tlsName in memory.
The memory will be reused and must not be freed.
If resetB is false (default) than no reset is done

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	tlsName	An per-thread unique name (string) to identify the reuse-able instance-storage. if *tlsName* is `MK_NULL` or `""` than a `MK_NULL` is returned
[in]	resetB	should the new object be reset?

Returns: the new MkBufferC instance, the instance belongs to the TLS-function and does not need to be deleted.

Note: This function is intended as a replacement for MkBufferCreateTLS_T for non-C programming languages.

Attention: for usage of the TLS-storage read more at StorageCreateTLS

◆ MkBufferCreateTLS_T()

void MkBufferCreateTLS_T	(	MK_MACRO_TYP	cls,
		MK_MACRO_TYP	name,
		MK_NUM const	size )

◆ MkBufferDelete_RT()

MK_EXTERN void MkBufferDelete_RT	(	MK_RT	mkrt,
		MK_BUF const	buf )

Destructor - delete a MkBufferC instance …

There are two different ways to delete an instance:

ObjectDispose	to free the internal data but keep the outher shell alive - this is called a SOFT-DELETE
ObjectDelete	to delete the outher shell including the internal data - this is called a HARD-DELETE

Attention

The internal memory will be freed and the object-pointer will be set to NULL. If the object-pointer is already NULL nothing will be done.
For a programming language without HARD-Delete support, the "Delete" method is assigned to a SOFT-Delete.
For a programming language without garbage collection, a SOFT-delete without a HARD-delete causes a small memory loss (C++: ~32 bytes).
After a SOFT-delete, the outher shell is still alive, but cannot be used. Any access to this shell generates an HDL-null-exception, but this exception can be caught. This is important for C++ as it prevents a core dump.
On HARD-delete read more at MkSelfDeleteForce

See also: BufferCreate BufferDup MqReadBUF

◆ MkBufferDup_RT()

MK_EXTERN MK_BUF MkBufferDup_RT	(	MK_RT	mkrt,
		MK_BUFN const	buf )

Dup-Constructor - create a new MkBufferC instance as copy from an existing MkBufferC instance

The new instance belongs to the caller and may have to be released if necessary. A manual release using BufferDelete is always possible, but the instance can no longer be used afterwards.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	buf	the MkBufferS instance to work on

Returns: The newly created MkBufferC instance, the instance is owned by the caller

See also: MkObjDup MkBufferDelete

◆ MkBufferFree_RT()

MK_EXTERN void MkBufferFree_RT	(	MK_RT	mkrt,
		MK_BUF const	buf )

initialize or free an MkBufferC reference-instance …

MkBufferInit and MkBufferFree are used for stack-storage (reference)
MkBufferCreate and MkBufferDelete are used for heap-storage (pointer → malloc,free)

Example: create a buffer-reference with default size (ILS) of 64 bytes.

MkBuffer64CR bufR = {0};                // MkBuffer64CR = typedef struct MkBuffer64S
MK_BUF const buf = MkBUF(&bufR);        // get the POINTER from a REFERENCE
MkBufferInit(buf,MkBuffer64C_TT,0);     // MkBufferInit operate on POINTER
...
// or use the predefined template-macro
MkBufferCreateLOCAL_T(MkBuffer64C,buf,0);
...
// finally free the memory, free is *only* done if internal memory-manager have switched to *heap* storage.
MkBufferFree(buf);

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	buf	the MkBufferS instance to work on - attention: have to be initialised with `'\0'`

◆ MkBufferInit_RT()

MK_EXTERN void MkBufferInit_RT	(	MK_RT	mkrt,
		MK_BUF const	buf,
		MK_TYP	type,
		MK_NUM const	size )

initialize or free an MkBufferC reference-instance …

MkBufferInit and MkBufferFree are used for stack-storage (reference)
MkBufferCreate and MkBufferDelete are used for heap-storage (pointer → malloc,free)

Example: create a buffer-reference with default size (ILS) of 64 bytes.

MkBuffer64CR bufR = {0};                // MkBuffer64CR = typedef struct MkBuffer64S
MK_BUF const buf = MkBUF(&bufR);        // get the POINTER from a REFERENCE
MkBufferInit(buf,MkBuffer64C_TT,0);     // MkBufferInit operate on POINTER
...
// or use the predefined template-macro
MkBufferCreateLOCAL_T(MkBuffer64C,buf,0);
...
// finally free the memory, free is *only* done if internal memory-manager have switched to *heap* storage.
MkBufferFree(buf);

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	buf	the MkBufferS instance to work on - attention: have to be initialised with `'\0'`
[in]	type	A type defined as MkTypeS with a TT postfix - (default: NULL=MkBuffer64S)
[in]	size	The initial size of the instance-local-storage. The MkBufferC has dynamic-memory-management, the size value is just a hint to provide enought memory for future tasks. The real size created is the maximum of type-ILS-size and size . (default: 0 = use the type-ILS-size)

◆ MkBufferMerge_RT()

MK_EXTERN MK_BUF MkBufferMerge_RT	(	MK_RT	mkrt,
		MK_BUF const	buf )

Merge-Constructor - create a new MkBufferC as a merge from an existing object …

The Merge-Constructor create a new instance and merge all internal data from the src into the new instance. After the Merge-Constructor the BufferResetFull is called for the merge-source bus.

One usage of the Merge-Constructor is to get a lightweight-copy of a Thread-Local-Storage object for external usage.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	buf	the MkBufferS instance to work on

Returns: The new instance or MK_NULL on error or if no Merge-Constructor is available

Attention: The new instance have to be deleted with BufferDelete

See also: BufferDup BufferResetFull BufferDelete

Macros

Functions

MkBufferC - MkBufferC_TOR_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MkBufferCreate

◆ MkBufferCreate1024

◆ MkBufferCreate1024_0

◆ MkBufferCreate1024_NULL

◆ MkBufferCreate256

◆ MkBufferCreate256_0

◆ MkBufferCreate256_NULL

◆ MkBufferCreate64

◆ MkBufferCreate64_0

◆ MkBufferCreate64_NULL

◆ MkBufferCreate_0

◆ MkBufferCreate_1

◆ MkBufferCreate_NULL

◆ MkBufferCreateBIN

◆ MkBufferCreateBIN_NULL

◆ MkBufferCreateBOL

◆ MkBufferCreateBOL_NULL

◆ MkBufferCreateBUF

◆ MkBufferCreateBUF_NULL

◆ MkBufferCreateDBL

◆ MkBufferCreateDBL_NULL

◆ MkBufferCreateFLT

◆ MkBufferCreateFLT_NULL

◆ MkBufferCreateI16

◆ MkBufferCreateI16_NULL

◆ MkBufferCreateI32

◆ MkBufferCreateI32_NULL

◆ MkBufferCreateI64

◆ MkBufferCreateI64_NULL

◆ MkBufferCreateI8

◆ MkBufferCreateI8_NULL

◆ MkBufferCreateLOCAL_T

◆ MkBufferCreateSTR

◆ MkBufferCreateSTR_NULL

◆ MkBufferCreateTLS

◆ MkBufferCreateTLS_1

◆ MkBufferCreateTLS_inout_T

◆ MkBufferCreateTLS_NULL

◆ MkBufferCreateTLS_T

◆ MkBufferDelete

◆ MkBufferDup

◆ MkBufferDup_NULL

◆ MkBufferFree

◆ MkBufferFree_NULL

◆ MkBufferInit

◆ MkBufferInit_1

◆ MkBufferInit_2

◆ MkBufferInit_NULL

◆ MkBufferMerge

◆ MkBufferMerge_NULL

Function Documentation

◆ MkBufferCreate1024_RT()

◆ MkBufferCreate256_RT()

◆ MkBufferCreate64_RT()

◆ MkBufferCreate_RT()

◆ MkBufferCreateBIN_RT()

◆ MkBufferCreateBOL_RT()

◆ MkBufferCreateBUF_RT()

◆ MkBufferCreateDBL_RT()

◆ MkBufferCreateFLT_RT()

◆ MkBufferCreateI16_RT()

◆ MkBufferCreateI32_RT()

◆ MkBufferCreateI64_RT()

◆ MkBufferCreateI8_RT()

◆ MkBufferCreateLOCAL_T()

◆ MkBufferCreateSTR_RT()

◆ MkBufferCreateTLS_inout_T()

◆ MkBufferCreateTLS_RT()

◆ MkBufferCreateTLS_T()

◆ MkBufferDelete_RT()

◆ MkBufferDup_RT()

◆ MkBufferFree_RT()

◆ MkBufferInit_RT()

◆ MkBufferMerge_RT()