MkBufferStreamC - various functions to create and destroy a MkBufferStreamS … More...

Collaboration diagram for MkBufferStreamC_Misc_C_API:

Macros
#define	MkBufferStreamLog_5F(bus, fmt, ...)

#define	MkBufferStreamLog_2F(bus, fmt)

#define	MkBufferStreamLog_3F(bus, fmt, pfx)

Functions
MK_BUS	MkBufferStreamCopy_RT (MK_RT mkrt, MK_BUS const bus, MK_BUSN const src)
	copy the MkBufferStreamC from src to bus …

MK_BUS	MkBufferStreamReset_RT (MK_RT mkrt, MK_BUS const bus)
	reset a MkBufferStreamC to the length zero …

void	MkBufferStreamResetFull_RT (MK_RT mkrt, MK_BUS const bus)
	reset a MkBufferStreamC to the length zero and free allocated storage…

void	MkBufferStreamLogS_RT (MK_RT mkrt, MK_BUS const bus, MK_OBJ fmtobj, MK_STRN const callfunc)

void	MkBufferStreamLog_RT (MK_RT mkrt, MK_BUS const bus, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
	log the MkBufferStreamC …

void	MkBufferStreamPosToStart_RT (MK_RT mkrt, MK_BUS const bus)
	set the current-access-position to the start of MkBufferStreamC …

MK_STRN	MkBufferStreamToString_RT (MK_RT mkrt, MK_BUSN const inst)
	String-Slot - returns the string representation of the *inst* …

MK_BFL	MkBufferStreamToBFL_RT (MK_RT mkrt, MK_BUSN const bus)
	convert the *bus* into a MkBufferListC …

MkBufferStreamC - MkBufferStreamC_Misc_C_API - overload
#define	MkBufferStreamCopy_NULL(...)

#define	MkBufferStreamCopy(...)

#define	MkBufferStreamReset_NULL(...)

#define	MkBufferStreamReset(...)

#define	MkBufferStreamToBFL_NULL(...)

#define	MkBufferStreamToBFL(...)

#define	MkBufferStreamLog_NULL(...)

#define	MkBufferStreamLog(...)

#define	MkBufferStreamLog_4(bus, fmtobj, debug, callfunc)

#define	MkBufferStreamLog_3(bus, fmtobj, debug)

#define	MkBufferStreamLog_2(bus, fmtobj)

#define	MkBufferStreamLog_1(bus)

#define	MkBufferStreamLogS_NULL(...)

#define	MkBufferStreamLogS(...)

#define	MkBufferStreamLogS_2(bus, fmtobj)

#define	MkBufferStreamLogS_1(bus)

#define	MkBufferStreamPosToStart_NULL(...)

#define	MkBufferStreamPosToStart(...)

#define	MkBufferStreamResetFull_NULL(...)

#define	MkBufferStreamResetFull(...)

#define	MkBufferStreamToString_NULL(...)

#define	MkBufferStreamToString(...)

Detailed Description

MkBufferStreamC - various functions to create and destroy a MkBufferStreamS …

Macro Definition Documentation

◆ MkBufferStreamCopy

#define MkBufferStreamCopy ( ... )

Value:

MkBufferStreamCopy_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamCopy_RT

MK_BUS MkBufferStreamCopy_RT(MK_RT mkrt, MK_BUS const bus, MK_BUSN const src)

copy the MkBufferStreamC from src to bus …

MK_RT_CALL

#define MK_RT_CALL

Definition LibMkKernel_mk.h:895

Definition at line 686 of file kernel_overload_mk.h.

◆ MkBufferStreamCopy_NULL

#define MkBufferStreamCopy_NULL ( ... )

Value:

MkBufferStreamCopy_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition LibMkKernel_mk.h:899

Definition at line 685 of file kernel_overload_mk.h.

◆ MkBufferStreamLog

#define MkBufferStreamLog ( ... )

Value:

MkBufferStreamLog_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamLog_RT

void MkBufferStreamLog_RT(MK_RT mkrt, MK_BUS const bus, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)

log the MkBufferStreamC …

Definition at line 694 of file kernel_overload_mk.h.

◆ MkBufferStreamLog_1

#define MkBufferStreamLog_1 ( bus )

Value:

MkBufferStreamLog(bus,NULL,0,__func__,0)

MkBufferStreamLog

#define MkBufferStreamLog(...)

Definition kernel_overload_mk.h:694

Definition at line 698 of file kernel_overload_mk.h.

◆ MkBufferStreamLog_2

#define MkBufferStreamLog_2	(		bus,
			fmtobj )

Value:

MkBufferStreamLog(bus,fmtobj,0,__func__,0)

Definition at line 697 of file kernel_overload_mk.h.

◆ MkBufferStreamLog_2F

#define MkBufferStreamLog_2F	(		bus,
			fmt )

Value:

MkBufferStreamLog_5F(bus,fmt,0,__func__,0)

MkBufferStreamLog_5F

#define MkBufferStreamLog_5F(bus, fmt,...)

Definition LibMkKernel_mk.h:8542

Definition at line 8543 of file LibMkKernel_mk.h.

◆ MkBufferStreamLog_3

#define MkBufferStreamLog_3	(	bus,
		fmtobj,
		debug )

Value:

MkBufferStreamLog(bus,fmtobj,debug,__func__,0)

Definition at line 696 of file kernel_overload_mk.h.

◆ MkBufferStreamLog_3F

#define MkBufferStreamLog_3F	(	bus,
		fmt,
		pfx )

Value:

MkBufferStreamLog_5F(bus,fmt,0,pfx,0)

Definition at line 8544 of file LibMkKernel_mk.h.

◆ MkBufferStreamLog_4

#define MkBufferStreamLog_4	(	bus,
		fmtobj,
		debug,
		callfunc )

Value:

MkBufferStreamLog(bus,fmtobj,debug,callfunc,0)

Definition at line 695 of file kernel_overload_mk.h.

◆ MkBufferStreamLog_5F

#define MkBufferStreamLog_5F	(	bus,
		fmt,
		... )

Value:

MkBufferStreamLog(bus,MkObj(fmt),__VA_ARGS__)

MkObj

static MK_OBJ MkObj(MK_MNG mng)

cast a unknown-object into an MkObjectS pointer or NULL if not possible

Definition LibMkKernel_mk.h:3530

Definition at line 8542 of file LibMkKernel_mk.h.

◆ MkBufferStreamLog_NULL

#define MkBufferStreamLog_NULL ( ... )

Value:

MkBufferStreamLog_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 693 of file kernel_overload_mk.h.

◆ MkBufferStreamLogS

#define MkBufferStreamLogS ( ... )

Value:

MkBufferStreamLogS_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamLogS_RT

void MkBufferStreamLogS_RT(MK_RT mkrt, MK_BUS const bus, MK_OBJ fmtobj, MK_STRN const callfunc)

Definition at line 700 of file kernel_overload_mk.h.

◆ MkBufferStreamLogS_1

#define MkBufferStreamLogS_1 ( bus )

Value:

MkBufferStreamLogS(bus,NULL,__func__)

MkBufferStreamLogS

#define MkBufferStreamLogS(...)

Definition kernel_overload_mk.h:700

Definition at line 702 of file kernel_overload_mk.h.

◆ MkBufferStreamLogS_2

#define MkBufferStreamLogS_2	(		bus,
			fmtobj )

Value:

MkBufferStreamLogS(bus,fmtobj,__func__)

Definition at line 701 of file kernel_overload_mk.h.

◆ MkBufferStreamLogS_NULL

#define MkBufferStreamLogS_NULL ( ... )

Value:

MkBufferStreamLogS_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 699 of file kernel_overload_mk.h.

◆ MkBufferStreamPosToStart

#define MkBufferStreamPosToStart ( ... )

Value:

MkBufferStreamPosToStart_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamPosToStart_RT

void MkBufferStreamPosToStart_RT(MK_RT mkrt, MK_BUS const bus)

set the current-access-position to the start of MkBufferStreamC …

Definition at line 704 of file kernel_overload_mk.h.

◆ MkBufferStreamPosToStart_NULL

#define MkBufferStreamPosToStart_NULL ( ... )

Value:

MkBufferStreamPosToStart_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 703 of file kernel_overload_mk.h.

◆ MkBufferStreamReset

#define MkBufferStreamReset ( ... )

Value:

MkBufferStreamReset_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamReset_RT

MK_BUS MkBufferStreamReset_RT(MK_RT mkrt, MK_BUS const bus)

reset a MkBufferStreamC to the length zero …

Definition at line 688 of file kernel_overload_mk.h.

◆ MkBufferStreamReset_NULL

#define MkBufferStreamReset_NULL ( ... )

Value:

MkBufferStreamReset_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 687 of file kernel_overload_mk.h.

◆ MkBufferStreamResetFull

#define MkBufferStreamResetFull ( ... )

Value:

MkBufferStreamResetFull_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamResetFull_RT

void MkBufferStreamResetFull_RT(MK_RT mkrt, MK_BUS const bus)

reset a MkBufferStreamC to the length zero and free allocated storage…

Definition at line 706 of file kernel_overload_mk.h.

◆ MkBufferStreamResetFull_NULL

#define MkBufferStreamResetFull_NULL ( ... )

Value:

MkBufferStreamResetFull_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 705 of file kernel_overload_mk.h.

◆ MkBufferStreamToBFL

#define MkBufferStreamToBFL ( ... )

Value:

MkBufferStreamToBFL_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamToBFL_RT

MK_BFL MkBufferStreamToBFL_RT(MK_RT mkrt, MK_BUSN const bus)

convert the bus into a MkBufferListC …

Definition at line 690 of file kernel_overload_mk.h.

◆ MkBufferStreamToBFL_NULL

#define MkBufferStreamToBFL_NULL ( ... )

Value:

MkBufferStreamToBFL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 689 of file kernel_overload_mk.h.

◆ MkBufferStreamToString

#define MkBufferStreamToString ( ... )

Value:

MkBufferStreamToString_RT(MK_RT_CALL __VA_ARGS__)

MkBufferStreamToString_RT

MK_STRN MkBufferStreamToString_RT(MK_RT mkrt, MK_BUSN const inst)

String-Slot - returns the string representation of the inst …

Definition at line 708 of file kernel_overload_mk.h.

◆ MkBufferStreamToString_NULL

#define MkBufferStreamToString_NULL ( ... )

Value:

MkBufferStreamToString_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 707 of file kernel_overload_mk.h.

Function Documentation

◆ MkBufferStreamCopy_RT()

MK_BUS MkBufferStreamCopy_RT	(	MK_RT	mkrt,
		MK_BUS const	bus,
		MK_BUSN const	src )

copy the MkBufferStreamC from src to bus …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bus	the MkBufferStreamS instance to work on
	src	source of the copy

Returns: the bus instance

◆ MkBufferStreamLog_RT()

void MkBufferStreamLog_RT	(	MK_RT	mkrt,
		MK_BUS const	bus,
		MK_OBJN	fmtobj,
		MK_DBG const	debug,
		MK_STRN const	callfunc,
		MK_I32 const	lvl )

log the MkBufferStreamC …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	bus	the MkBufferStreamS instance to work on
[in]	fmtobj	managed object used to format the log-message (default=null → use default-format)
[in]	debug	the `debug level` from MkRuntimeS::debug, use `0 <= debug <= 9` (default=`0`)
[in]	callfunc	a user-defined postfix to identify the calling-function or the environment (default = name-of-function, null = resolve-own-name)
[in]	lvl	a user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=`0`)

◆ MkBufferStreamLogS_RT()

void MkBufferStreamLogS_RT	(	MK_RT	mkrt,
		MK_BUS const	bus,
		MK_OBJ	fmtobj,
		MK_STRN const	callfunc )

◆ MkBufferStreamPosToStart_RT()

void MkBufferStreamPosToStart_RT	(	MK_RT	mkrt,
		MK_BUS const	bus )

set the current-access-position to the start of MkBufferStreamC …

◆ MkBufferStreamReset_RT()

MK_BUS MkBufferStreamReset_RT	(	MK_RT	mkrt,
		MK_BUS const	bus )

reset a MkBufferStreamC to the length zero …

Parameters

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

See also: bus.ResetFull()

◆ MkBufferStreamResetFull_RT()

void MkBufferStreamResetFull_RT	(	MK_RT	mkrt,
		MK_BUS const	bus )

reset a MkBufferStreamC to the length zero and free allocated storage…

In addition to MkBufferStreamC bus.Reset() the allocated storage is freed and reset to ILS. This is usefull if the internal storage was filled once with a huge amount of data.

Parameters

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

See also: MkBufferStreamC bus.Reset()

◆ MkBufferStreamToBFL_RT()

MK_BFL MkBufferStreamToBFL_RT	(	MK_RT	mkrt,
		MK_BUSN const	bus )

convert the bus into a MkBufferListC …

Parameters

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

Returns: the MkBufferListC instance requested or MkBufferListGetNull on error

Note: (do not free) The memory of the out/return value belongs to the called csmkkernel function and therefore never becomes null for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

◆ MkBufferStreamToString_RT()

MK_STRN MkBufferStreamToString_RT	(	MK_RT	mkrt,
		MK_BUSN const	inst )

String-Slot - returns the string representation of the inst …

The string is a human-readable form of the data stored in the object.

See also: slot: every class should provide a ToString function by default.

Parameters

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

Returns: the requested string or "MK_NULL" on error

Note: (do not free) The memory of the out/return value belongs to the called csmkkernel function and therefore never becomes null for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

Macros

Functions

MkBufferStreamC - MkBufferStreamC_Misc_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MkBufferStreamCopy

◆ MkBufferStreamCopy_NULL

◆ MkBufferStreamLog

◆ MkBufferStreamLog_1

◆ MkBufferStreamLog_2

◆ MkBufferStreamLog_2F

◆ MkBufferStreamLog_3

◆ MkBufferStreamLog_3F

◆ MkBufferStreamLog_4

◆ MkBufferStreamLog_5F

◆ MkBufferStreamLog_NULL

◆ MkBufferStreamLogS

◆ MkBufferStreamLogS_1

◆ MkBufferStreamLogS_2

◆ MkBufferStreamLogS_NULL

◆ MkBufferStreamPosToStart

◆ MkBufferStreamPosToStart_NULL

◆ MkBufferStreamReset

◆ MkBufferStreamReset_NULL

◆ MkBufferStreamResetFull

◆ MkBufferStreamResetFull_NULL

◆ MkBufferStreamToBFL

◆ MkBufferStreamToBFL_NULL

◆ MkBufferStreamToString

◆ MkBufferStreamToString_NULL

Function Documentation

◆ MkBufferStreamCopy_RT()

◆ MkBufferStreamLog_RT()

◆ MkBufferStreamLogS_RT()

◆ MkBufferStreamPosToStart_RT()

◆ MkBufferStreamReset_RT()

◆ MkBufferStreamResetFull_RT()

◆ MkBufferStreamToBFL_RT()

◆ MkBufferStreamToString_RT()