theKernel 10.0 NHI1 - theKernel - theLink - theConfig - theSq3Lite - theCompiler - theBrain - theGuard
c - tcl - py - rb - jv - cc
Loading...
Searching...
No Matches
MkObjectC_Class_C_API

MkObjectC - define the class … More...

+ Collaboration diagram for MkObjectC_Class_C_API:

Topics

 MkObjectC_Class_Introspection_C_API
 MkObjectC - get information from the MkTypeS
 
 MkObjectC_Class_Define_C_API
 MkObjectC - low level definition, access and cast …
 

Typedefs

typedef struct MkObjectSlibmkkernel::MK_OBJ
 class-shortcut for struct MkObjectS *, all shortcut using the XX_YYY syntax (only for public API) …
 
typedef const struct MkObjectSlibmkkernel::MK_OBJN
 class-shortcut for const struct MkObjectS *, all const shortcut using the XX_YYYC syntax (only for public API) …
 
typedef struct MkObjectS libmkkernel::MK_OBJR
 reference-shortcut for struct MkObjectS, all shortcut using the XX_YYYR syntax (only for public API) …
 

MkObjectC - Export - inline - interact with an external software

MK_EXTERN MK_HDL libmkkernel::MkObjectHandleGet_RT (MK_RT mkrt, MK_OBJ const obj)
 Handle-Get-Slot - returns a export-hdl to the MkObjectC useable for external storage
 
MK_EXTERN MK_OBJ libmkkernel::MkObjectHandleResolve_RT (MK_RT mkrt, MK_HDL const netHdl)
 Handle-Resolve-Slot - return a MkObjectC from netHdl or MK_NULL if invalid…
 
MK_EXTERN void libmkkernel::MkObjectHandleDeleteByNetHdl_RT (MK_RT mkrt, MK_HDL const netHdl)
 Handle-Delete-Slot - delete a netHdl from handle-storage …
 
MK_EXTERN void libmkkernel::MkObjectHandleDelete_RT (MK_RT mkrt, MK_OBJ const netObj)
 Handle-Delete-Slot - delete a netObj from handle-storage …
 
#define MkObjectHandleGet_1X(x)
 
#define MkObjectHandleResolve_e(netHdl)
 wrapper for MkObjectHandleResolve with error-handline
 

MkObjectC - Misc - function - unspecified functions to perform different tasks

MK_OBJ libmkkernel::MkObjectGetNull (void)
 Null-Slot - return a MkObjectC typed NULL instance …
 

MkObjectC - Introspection - inline - access to all instances created by class starting with the last one

MK_OBJ libmkkernel::MkObjectInstances_RT (MK_PARSER_RT_ONLY)
 get head-instance from linked-list of MkObjectS type …
 
MK_OBJ libmkkernel::MkObjectNext (MK_OBJ const obj)
 get next instance from linked-list of MkObjectS type
 
MK_OBJ libmkkernel::MkObjectPrev (MK_OBJ const obj)
 get previous instance from linked-list of MkObjectS type
 

MkObjectC - Export - overload

#define MkObjectHandleResolve_NULL(...)
 
#define MkObjectHandleResolve(...)
 
#define MkObjectHandleDelete_NULL(...)
 
#define MkObjectHandleDelete(...)
 
#define MkObjectHandleGet_NULL(...)
 
#define MkObjectHandleGet(...)
 
#define MkObjectHandleDeleteByNetHdl_NULL(...)
 
#define MkObjectHandleDeleteByNetHdl(...)
 

MkObjectC - Introspection - overload

#define MkObjectInstances_NULL()
 
#define MkObjectInstances()
 

Detailed Description

MkObjectC - define the class …

Macro Definition Documentation

◆ MkObjectHandleDelete

#define MkObjectHandleDelete ( ...)
Value:
MkObjectHandleDelete_RT(MK_RT_CALL __VA_ARGS__)
#define MK_RT_CALL

Definition at line 1465 of file kernel_overload_mk.h.

◆ MkObjectHandleDelete_NULL

#define MkObjectHandleDelete_NULL ( ...)
Value:
MkObjectHandleDelete_RT(MK_RT_CALL_NULL __VA_ARGS__)
#define MK_RT_CALL_NULL

Definition at line 1464 of file kernel_overload_mk.h.

◆ MkObjectHandleDeleteByNetHdl

#define MkObjectHandleDeleteByNetHdl ( ...)
Value:
MkObjectHandleDeleteByNetHdl_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 1471 of file kernel_overload_mk.h.

◆ MkObjectHandleDeleteByNetHdl_NULL

#define MkObjectHandleDeleteByNetHdl_NULL ( ...)
Value:
MkObjectHandleDeleteByNetHdl_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1470 of file kernel_overload_mk.h.

◆ MkObjectHandleGet

#define MkObjectHandleGet ( ...)
Value:
MkObjectHandleGet_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 1467 of file kernel_overload_mk.h.

◆ MkObjectHandleGet_1X

#define MkObjectHandleGet_1X ( x)
Value:
#define MkObjectHandleGet(...)
#define MkOBJ(x)
cast a known-object into an MkObjectS pointer

Definition at line 3337 of file LibMkKernel_mk.h.

◆ MkObjectHandleGet_NULL

#define MkObjectHandleGet_NULL ( ...)
Value:
MkObjectHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1466 of file kernel_overload_mk.h.

◆ MkObjectHandleResolve

#define MkObjectHandleResolve ( ...)
Value:
MkObjectHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 1461 of file kernel_overload_mk.h.

◆ MkObjectHandleResolve_e

#define MkObjectHandleResolve_e ( netHdl)
Value:
({ \
MK_HDL tmpHdl=netHdl; \
MK_OBJ tmp; \
if (tmpHdl==0) { \
tmp=NULL; \
} else { \
tmp=MkObjectHandleResolve(tmpHdl); \
if (tmp==NULL) { \
MkErrorSetC_1_NULL("ERROR: 'MkObjectC' handle is 'NULL'"); \
goto error; \
}; \
}; \
tmp; \
})
#define MkObjectHandleResolve(...)

wrapper for MkObjectHandleResolve with error-handline

Parameters
[in]netHdlThe handle previously returned by MkObjectHandleGet.
Returns
Return an valid libmkkernel::MK_OBJ or MK_NULL with an error set.
  • If netHdl is 0 than MK_NULL is returned and the upper-code decide how to deal with it.
  • MkObjectHandleResolve return an valid libmkkernel::MK_OBJ or MK_NULL if the netHdl is invalid or the underlying object has already been deleted.
    • If a MK_NULL is returned than an error-message is created and a jump to the label error is done.
    • If a libmkkernel::MK_OBJ is returned than the netHdl is valid.

Definition at line 3361 of file LibMkKernel_mk.h.

3361#define MkObjectHandleResolve_e(netHdl) ({ \
3362 MK_HDL tmpHdl=netHdl; \
3363 MK_OBJ tmp; \
3364 if (tmpHdl==0) { \
3365 tmp=NULL; \
3366 } else { \
3367 tmp=MkObjectHandleResolve(tmpHdl); \
3368 if (tmp==NULL) { \
3369 MkErrorSetC_1_NULL("ERROR: 'MkObjectC' handle is 'NULL'"); \
3370 goto error; \
3371 }; \
3372 }; \
3373 tmp; \
3374})

◆ MkObjectHandleResolve_NULL

#define MkObjectHandleResolve_NULL ( ...)
Value:
MkObjectHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1460 of file kernel_overload_mk.h.

◆ MkObjectInstances

#define MkObjectInstances ( )
Value:
MkObjectInstances_RT(MK_RT_CALL_ONLY)
#define MK_RT_CALL_ONLY

Definition at line 1482 of file kernel_overload_mk.h.

◆ MkObjectInstances_NULL

#define MkObjectInstances_NULL ( )
Value:
MkObjectInstances_RT(MK_RT_CALL_NULL_ONLY)
#define MK_RT_CALL_NULL_ONLY

Definition at line 1481 of file kernel_overload_mk.h.

Typedef Documentation

◆ MK_OBJ

typedef struct MkObjectS* libmkkernel::MK_OBJ

class-shortcut for struct MkObjectS *, all shortcut using the XX_YYY syntax (only for public API) …

Definition at line 1379 of file LibMkKernel_mk.h.

◆ MK_OBJN

typedef const struct MkObjectS* libmkkernel::MK_OBJN

class-shortcut for const struct MkObjectS *, all const shortcut using the XX_YYYC syntax (only for public API) …

Definition at line 1382 of file LibMkKernel_mk.h.

◆ MK_OBJR

reference-shortcut for struct MkObjectS, all shortcut using the XX_YYYR syntax (only for public API) …

Definition at line 1385 of file LibMkKernel_mk.h.

Function Documentation

◆ MkObjectGetNull()

MK_OBJ libmkkernel::MkObjectGetNull ( void )
inline

Null-Slot - return a MkObjectC typed NULL instance …

Definition at line 3400 of file LibMkKernel_mk.h.

3400 {
3401 return (MK_OBJ)MK_NULL;
3402 }
#define MK_NULL
The Programming-Language-Micro-Kernel (PLMK) NULL value as MK_NULL in C++ …
+ Here is the caller graph for this function:

◆ MkObjectHandleDelete_RT()

MK_EXTERN void libmkkernel::MkObjectHandleDelete_RT ( MK_RT mkrt,
MK_OBJ const netObj )

Handle-Delete-Slot - delete a netObj from handle-storage …

+ Here is the caller graph for this function:

◆ MkObjectHandleDeleteByNetHdl_RT()

MK_EXTERN void libmkkernel::MkObjectHandleDeleteByNetHdl_RT ( MK_RT mkrt,
MK_HDL const netHdl )

Handle-Delete-Slot - delete a netHdl from handle-storage …

+ Here is the caller graph for this function:

◆ MkObjectHandleGet_RT()

MK_EXTERN MK_HDL libmkkernel::MkObjectHandleGet_RT ( MK_RT mkrt,
MK_OBJ const obj )

Handle-Get-Slot - returns a export-hdl to the MkObjectC useable for external storage

The export-hdl is a reference to an instance that can be stored in software and converted back into an instance using the MkObjectHandleResolve.

The export-hdl is only valid until the Programming-Language-Micro-Kernel (PLMK) ends.

example: The export-hdl is used in rpc to identify an object across the network.

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]objthe MkObjectS instance to work on - a MANAGED OBJECT after type-check and able to be supported by the MkObjectS API
Returns
the required export-hdl

◆ MkObjectHandleResolve_RT()

MK_EXTERN MK_OBJ libmkkernel::MkObjectHandleResolve_RT ( MK_RT mkrt,
MK_HDL const netHdl )

Handle-Resolve-Slot - return a MkObjectC from netHdl or MK_NULL if invalid…

The MkObjectHandleResolve undo the MkObjectHandleGet and is intended to export a unique identifer into external code not belonging to the Programming-Language-Micro-Kernel (PLMK).

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]netHdlhandle former exported with MkObjectHandleGet
Returns
the required handle or MK_NULL if netHdl is invalid
+ Here is the caller graph for this function:

◆ MkObjectInstances_RT()

MK_OBJ libmkkernel::MkObjectInstances_RT ( MK_PARSER_RT_ONLY )
inline

get head-instance from linked-list of MkObjectS type …

The head-instance is the last instance created.

Definition at line 12507 of file LibMkKernel_mk.h.

12507 {
12509 return (MK_OBJ)MkObjectC_TT->instances;
12510}
#define MkObjectC_TT
class as MkTypeS-class-type, useable in a class-macro as: class##_TT …
#define MK_CLASS_RT
+ Here is the caller graph for this function:

◆ MkObjectNext()

MK_OBJ libmkkernel::MkObjectNext ( MK_OBJ const obj)
inline

get next instance from linked-list of MkObjectS type

Definition at line 12514 of file LibMkKernel_mk.h.

12514 {
12515 MK_INSTANCE_HDL(obj);
12516 return (MK_OBJ)MkObjectC_X2obj(obj)->obj_protect.next;
12517}
#define MkObjectC_X2obj(x)
#define MK_INSTANCE_HDL(x)
+ Here is the caller graph for this function:

◆ MkObjectPrev()

MK_OBJ libmkkernel::MkObjectPrev ( MK_OBJ const obj)
inline

get previous instance from linked-list of MkObjectS type

Definition at line 12521 of file LibMkKernel_mk.h.

12521 {
12522 MK_INSTANCE_HDL(obj);
12523 return (MK_OBJ)MkObjectC_X2obj(obj)->obj_protect.prev;
12524}
+ Here is the caller graph for this function: