MkObjectC - various functions related to the MkObjectS … More...

Collaboration diagram for MkObjectC_Misc_C_API:

Macros
#define	MkObjectToName_1X(x)

#define	MkObjectToNameOfType_1X(x)

#define	MkObjectToNameOfClass_1X(x)

#define	MkObjectToString_1X(x)

#define	MkObjectToString_1M(m)

#define	MkObjectToError_1X(obj)

Functions
MK_STRN const	MkObjectToName_RT (MK_RT mkrt, MK_OBJN const obj)
	Info-Slot - returns brief information about the obj as a string

MK_STRN	MkObjectToNameOfType_RT (MK_RT mkrt, MK_OBJN const obj)
	Type-Slot - returns the LibMkKernel-Type-Name of the obj as a string

MK_STRN	MkObjectToNameOfClass_RT (MK_RT mkrt, MK_OBJ const obj)
	Class-Slot - returns the C-Class-Name of the obj as string

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

static bool	MkObjectIsNull (MK_OBJ const obj)
	ckeck if the object is `MK_NULL`

MK_ERR	MkObjectErrorCatch_RT (MK_RT mkrt, MK_OBJN const obj, MK_EXP const exception, MK_STRN const callfunc)
	convert a programming-language-error into an libmkkernel error …

static MK_ERR	MkObjectToError_RT (MK_RT mkrt, MK_OBJ const obj)
	Error-Slot - return an error-object pre initialized with *obj* data.

MkObjectC - MkObjectC_Misc_C_API - function
MK_ERR	MkObjectToErrorP (MK_RT mkrt, MK_OBJ const obj)
	Non-inline replacement for MkObjectToError …

MK_BOOL	MkObjectIsNullP (MK_OBJ const obj)
	Non-inline replacement for MkObjectIsNull …

MkObjectC - MkObjectC_Misc_C_API - overload
#define	MkObjectErrorCatch_NULL(...)

#define	MkObjectErrorCatch(...)

#define	MkObjectErrorCatch_2(obj, exception)

#define	MkObjectErrorCatch_1(obj)

#define	MkObjectToError_NULL(...)

#define	MkObjectToError(...)

#define	MkObjectInstancesOfType_NULL(...)

#define	MkObjectInstancesOfType(...)

#define	MkObjectToName_NULL(...)

#define	MkObjectToName(...)

#define	MkObjectToNameOfClass_NULL(...)

#define	MkObjectToNameOfClass(...)

#define	MkObjectToNameOfType_NULL(...)

#define	MkObjectToNameOfType(...)

#define	MkObjectToString_NULL(...)

#define	MkObjectToString(...)

Detailed Description

MkObjectC - various functions related to the MkObjectS …

Macro Definition Documentation

◆ MkObjectErrorCatch

#define MkObjectErrorCatch ( ... )

Value:

MkObjectErrorCatch_RT(MK_RT_CALL __VA_ARGS__)

MkObjectErrorCatch_RT

MK_ERR MkObjectErrorCatch_RT(MK_RT mkrt, MK_OBJN const obj, MK_EXP const exception, MK_STRN const callfunc)

convert a programming-language-error into an libmkkernel error …

MK_RT_CALL

#define MK_RT_CALL

Definition LibMkKernel_mk.h:895

Definition at line 1644 of file kernel_overload_mk.h.

◆ MkObjectErrorCatch_1

#define MkObjectErrorCatch_1 ( obj )

Value:

MkObjectErrorCatch(obj,NULL,__func__)

MkObjectErrorCatch

#define MkObjectErrorCatch(...)

Definition kernel_overload_mk.h:1644

Definition at line 1646 of file kernel_overload_mk.h.

◆ MkObjectErrorCatch_2

#define MkObjectErrorCatch_2	(		obj,
			exception )

Value:

MkObjectErrorCatch(obj,exception,__func__)

Definition at line 1645 of file kernel_overload_mk.h.

◆ MkObjectErrorCatch_NULL

#define MkObjectErrorCatch_NULL ( ... )

Value:

MkObjectErrorCatch_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition LibMkKernel_mk.h:899

Definition at line 1643 of file kernel_overload_mk.h.

◆ MkObjectInstancesOfType

#define MkObjectInstancesOfType ( ... )

Value:

MkObjectInstancesOfType_RT(MK_RT_CALL __VA_ARGS__)

MkObjectInstancesOfType_RT

static MK_OBJ MkObjectInstancesOfType_RT(MK_RT mkrt, MK_SIG typeSIG)

return the head-instance from a specific type defined by signature typeSIG …

Definition LibMkKernel_mk.h:13426

Definition at line 1652 of file kernel_overload_mk.h.

◆ MkObjectInstancesOfType_NULL

#define MkObjectInstancesOfType_NULL ( ... )

Value:

MkObjectInstancesOfType_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1651 of file kernel_overload_mk.h.

◆ MkObjectToError

#define MkObjectToError ( ... )

Value:

MkObjectToError_RT(MK_RT_CALL __VA_ARGS__)

MkObjectToError_RT

static MK_ERR MkObjectToError_RT(MK_RT mkrt, MK_OBJ const obj)

Error-Slot - return an error-object pre initialized with obj data.

Definition LibMkKernel_mk.h:13535

Definition at line 1648 of file kernel_overload_mk.h.

◆ MkObjectToError_1X

#define MkObjectToError_1X ( obj )

Value:

MkObjectToError(MkOBJ(obj))

MkOBJ

#define MkOBJ(x)

cast a known-object into an MkObjectS pointer

Definition LibMkKernel_mk.h:3551

MkObjectToError

#define MkObjectToError(...)

Definition kernel_overload_mk.h:1648

Definition at line 13543 of file LibMkKernel_mk.h.

◆ MkObjectToError_NULL

#define MkObjectToError_NULL ( ... )

Value:

MkObjectToError_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1647 of file kernel_overload_mk.h.

◆ MkObjectToName

#define MkObjectToName ( ... )

Value:

MkObjectToName_RT(MK_RT_CALL __VA_ARGS__)

MkObjectToName_RT

MK_STRN const MkObjectToName_RT(MK_RT mkrt, MK_OBJN const obj)

Info-Slot - returns brief information about the obj as a string

Definition at line 1656 of file kernel_overload_mk.h.

◆ MkObjectToName_1X

#define MkObjectToName_1X ( x )

Value:

MkObjectToName(MkOBJ(x))

MkObjectToName

#define MkObjectToName(...)

Definition kernel_overload_mk.h:1656

Definition at line 5233 of file LibMkKernel_mk.h.

◆ MkObjectToName_NULL

#define MkObjectToName_NULL ( ... )

Value:

MkObjectToName_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1655 of file kernel_overload_mk.h.

◆ MkObjectToNameOfClass

#define MkObjectToNameOfClass ( ... )

Value:

MkObjectToNameOfClass_RT(MK_RT_CALL __VA_ARGS__)

MkObjectToNameOfClass_RT

MK_STRN MkObjectToNameOfClass_RT(MK_RT mkrt, MK_OBJ const obj)

Class-Slot - returns the C-Class-Name of the obj as string

Definition at line 1658 of file kernel_overload_mk.h.

◆ MkObjectToNameOfClass_1X

#define MkObjectToNameOfClass_1X ( x )

Value:

MkObjectToNameOfClass_RT(MK_RT_CALL MkOBJ(x))

Definition at line 5273 of file LibMkKernel_mk.h.

◆ MkObjectToNameOfClass_NULL

#define MkObjectToNameOfClass_NULL ( ... )

Value:

MkObjectToNameOfClass_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1657 of file kernel_overload_mk.h.

◆ MkObjectToNameOfType

#define MkObjectToNameOfType ( ... )

Value:

MkObjectToNameOfType_RT(MK_RT_CALL __VA_ARGS__)

MkObjectToNameOfType_RT

MK_STRN MkObjectToNameOfType_RT(MK_RT mkrt, MK_OBJN const obj)

Type-Slot - returns the LibMkKernel-Type-Name of the obj as a string

Definition at line 1660 of file kernel_overload_mk.h.

◆ MkObjectToNameOfType_1X

#define MkObjectToNameOfType_1X ( x )

Value:

MkObjectToNameOfType(MkOBJ(x))

MkObjectToNameOfType

#define MkObjectToNameOfType(...)

Definition kernel_overload_mk.h:1660

Definition at line 5255 of file LibMkKernel_mk.h.

◆ MkObjectToNameOfType_NULL

#define MkObjectToNameOfType_NULL ( ... )

Value:

MkObjectToNameOfType_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1659 of file kernel_overload_mk.h.

◆ MkObjectToString

#define MkObjectToString ( ... )

Value:

MkObjectToString_RT(MK_RT_CALL __VA_ARGS__)

MkObjectToString_RT

MK_STRN MkObjectToString_RT(MK_RT mkrt, MK_OBJN const inst)

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

Definition at line 1662 of file kernel_overload_mk.h.

◆ MkObjectToString_1M

#define MkObjectToString_1M ( m )

Value:

MkObjectToString(m?MkObjN(m):NULL)

MkObjN

static MK_OBJN MkObjN(MK_MNGN mng)

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

Definition LibMkKernel_mk.h:3538

MkObjectToString

#define MkObjectToString(...)

Definition kernel_overload_mk.h:1662

Definition at line 5291 of file LibMkKernel_mk.h.

◆ MkObjectToString_1X

#define MkObjectToString_1X ( x )

Value:

MkObjectToString(x?MkOBJ(x):NULL)

Definition at line 5290 of file LibMkKernel_mk.h.

◆ MkObjectToString_NULL

#define MkObjectToString_NULL ( ... )

Value:

MkObjectToString_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1661 of file kernel_overload_mk.h.

Function Documentation

◆ MkObjectErrorCatch_RT()

MK_ERR MkObjectErrorCatch_RT	(	MK_RT	mkrt,
		MK_OBJN const	obj,
		MK_EXP const	exception,
		MK_STRN const	callfunc )

convert a programming-language-error into an libmkkernel error …

This function is a placeholder and have to be overloaded by the Target-Programming-Language (TPL). The goal is to handel an error-catch condition and convert an programming-language-error into an libmkkernel-error.

This is the same as (example form c++):

mngx->ErrorFORMAT()->Catch(exception)

Example from server.c → catch-send and reset an error

      MQ_CTX const clmqctx = srvctx->cl[clid];
      MqSendSTART_E (clmqctx);
      MqProxyItem_E (mqctx, clmqctx);
      if (MkErrorCheckI(MqSendEND_AND_WAIT(clmqctx, "ECOI", 5))) {
        MqContextErrorCopy (mqctx, clmqctx);
	MqSendI32_E (mqctx, MkErrorGetNum_0E());
	MqSendSTR_E (mqctx, MkErrorGetText_0E());
	MkErrorReset_1X(mqctx);
      }

Note: The C language does not support the MkErrorCatch because there is no native error object.; If there is no error at all the MkErrorCatch does nothing and just return the MkErrorDEFAULT.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	obj	the MkObjectS instance to work on - a MANAGED OBJECT after type-check and able to be supported by the MkObjectS API
[in]	exception	the exception object from C, if `MK_NULL` the global exception object is used
[in]	callfunc	a user-defined postfix to identify the calling-function or the environment (default = name-of-function, `MK_NULL` = resolve-own-name)

Returns: the ErrorDEFAULT initialized with exception value

See also: (runtime) enum MkErrorE MkErrorRaise(MK_ERRN const err) (runtime) enum MkErrorE MkErrorReset(MK_ERR const err, MK_STRN const callfunc, MK_I32 const callline, MK_BOOL const force)

◆ MkObjectIsNull()

static bool MkObjectIsNull ( MK_OBJ const obj )

inlinestatic

ckeck if the object is MK_NULL

Definition at line 5295 of file LibMkKernel_mk.h.

  {
  return (obj == MK_NULL);
}

◆ MkObjectIsNullP()

MK_BOOL MkObjectIsNullP ( MK_OBJ const obj )

Non-inline replacement for MkObjectIsNull …

◆ MkObjectToError_RT()

static MK_ERR MkObjectToError_RT	(	MK_RT	mkrt,
		MK_OBJ const	obj )

inlinestatic

Error-Slot - return an error-object pre initialized with obj data.

This slot is the same as ErrorDEFAULT with fmtobj set to this

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	obj	the MkObjectS instance to work on - a MANAGED OBJECT after type-check and able to be supported by the MkObjectS API

Returns: the error-object

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

Definition at line 13535 of file LibMkKernel_mk.h.

  {
  MK_INSTANCE_RT_O(obj);
  return MkErrorFORMAT_1O(obj);
}

◆ MkObjectToErrorP()

MK_ERR MkObjectToErrorP	(	MK_RT	mkrt,
		MK_OBJ const	obj )

Non-inline replacement for MkObjectToError …

◆ MkObjectToName_RT()

MK_STRN const MkObjectToName_RT	(	MK_RT	mkrt,
		MK_OBJN const	obj )

Info-Slot - returns brief information about the obj as a string

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	obj	the MkObjectS instance to work on - a MANAGED OBJECT after type-check and able to be supported by the MkObjectS API

Returns: the identification of the object as string

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

◆ MkObjectToNameOfClass_RT()

MK_STRN MkObjectToNameOfClass_RT	(	MK_RT	mkrt,
		MK_OBJ const	obj )

Class-Slot - returns the C-Class-Name of the obj as string

The Programming-Language-Micro-Kernel (PLMK) connect the C language with the libmkkernel runtime. Every class-object in C has an conterpart as libmkkernel type-object in the Programming-Language-Micro-Kernel (PLMK).

ObjectToNameOfType	returns the name of the libmkkernel type
ObjectToNameOfClass	returns the name of the C class

◆ MkObjectToNameOfType_RT()

MK_STRN MkObjectToNameOfType_RT	(	MK_RT	mkrt,
		MK_OBJN const	obj )

Type-Slot - returns the LibMkKernel-Type-Name of the obj as a string

The Programming-Language-Micro-Kernel (PLMK) connect the C language with the libmkkernel runtime. Every class-object in C has an conterpart as libmkkernel type-object in the Programming-Language-Micro-Kernel (PLMK).

ObjectToNameOfType	returns the name of the libmsgque type
ObjectToNameOfClass	returns the name of the C class

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	obj	the MkObjectS instance to work on - a MANAGED OBJECT after type-check and able to be supported by the MkObjectS API

Returns: the name of the object-type as a string

◆ MkObjectToString_RT()

MK_STRN MkObjectToString_RT	(	MK_RT	mkrt,
		MK_OBJN 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 libmkkernel function and therefore never becomes MK_NULL for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

Macros

Functions

MkObjectC - MkObjectC_Misc_C_API - function

MkObjectC - MkObjectC_Misc_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MkObjectErrorCatch

◆ MkObjectErrorCatch_1

◆ MkObjectErrorCatch_2

◆ MkObjectErrorCatch_NULL

◆ MkObjectInstancesOfType

◆ MkObjectInstancesOfType_NULL

◆ MkObjectToError

◆ MkObjectToError_1X

◆ MkObjectToError_NULL

◆ MkObjectToName

◆ MkObjectToName_1X

◆ MkObjectToName_NULL

◆ MkObjectToNameOfClass

◆ MkObjectToNameOfClass_1X

◆ MkObjectToNameOfClass_NULL

◆ MkObjectToNameOfType

◆ MkObjectToNameOfType_1X

◆ MkObjectToNameOfType_NULL

◆ MkObjectToString

◆ MkObjectToString_1M

◆ MkObjectToString_1X

◆ MkObjectToString_NULL

Function Documentation

◆ MkObjectErrorCatch_RT()

◆ MkObjectIsNull()

◆ MkObjectIsNullP()

◆ MkObjectToError_RT()

◆ MkObjectToErrorP()

◆ MkObjectToName_RT()

◆ MkObjectToNameOfClass_RT()

◆ MkObjectToNameOfType_RT()

◆ MkObjectToString_RT()