MkLogFileC_Class_C_API

MkLogFileC - define the class … More...

Collaboration diagram for MkLogFileC_Class_C_API:

Topics
	MkLogFileC_Class_Define_C_API
	MkLogFileC - low level definition, access and cast …

Typedefs
typedef struct MkLogFileS *	MK_LFL
	class-shortcut for struct MkLogFileS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct MkLogFileS *	MK_LFLN
	class-shortcut for const struct MkLogFileS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct MkLogFileS	MK_LFLR
	reference-shortcut for struct MkLogFileS, all shortcut using the XX_YYYR syntax (only for public API) …

MkLogFileC - Export - inline - interact with an external software
static MK_HDL	MkLogFileHandleGet_RT (MK_RT mkrt, MK_LFL const lfl)
	Handle-Get-Slot - returns a export-hdl to the MkLogFileC useable for external storage
static MK_LFL	MkLogFileHandleResolve_RT (MK_RT mkrt, MK_HDL const netHdl)
	Handle-Resolve-Slot - return a MkLogFileC from netHdl or MK_NULL if invalid…
#define	MkLogFileHandleResolve_e(netHdl)
	wrapper for MkLogFileHandleResolve with error-handline

MkLogFileC - Misc - function - unspecified functions to perform different tasks
static MK_LFL	MkLogFileGetNull (void)
	Null-Slot - return a MkLogFileC typed NULL instance …

MkLogFileC - Introspection - inline - access to all instances created by class starting with the last one
static MK_LFL	MkLogFileInstances_RT (MK_RT mkrt)
	get head-instance from linked-list of MkLogFileS type …
static MK_LFL	MkLogFileNext (MK_LFL const lfl)
	get next instance from linked-list of MkLogFileS type
static MK_LFL	MkLogFilePrev (MK_LFL const lfl)
	get previous instance from linked-list of MkLogFileS type

MkLogFileC - Export - function
MK_LFL	MkLogFileHandleResolveP (MK_RT mkrt, MK_HDL const netHdl)
	Non-inline replacement for MkLogFileHandleResolve …
MK_HDL	MkLogFileHandleGetP (MK_RT mkrt, MK_LFL const lfl)
	Non-inline replacement for MkLogFileHandleGet …

MkLogFileC - Introspection - function
MK_LFL	MkLogFileNextP (MK_LFL const lfl)
	Non-inline replacement for MkLogFileNext …
MK_LFL	MkLogFilePrevP (MK_LFL const lfl)
	Non-inline replacement for MkLogFilePrev …
MK_LFL	MkLogFileInstancesP (MK_RT mkrt)
	Non-inline replacement for MkLogFileInstances …

MkLogFileC - Misc - function
MK_LFL	MkLogFileGetNullP (void)
	Non-inline replacement for MkLogFileGetNull …

MkLogFileC - Export - overload
#define	MkLogFileHandleResolve_NULL(...)
#define	MkLogFileHandleResolve(...)
#define	MkLogFileHandleGet_NULL(...)
#define	MkLogFileHandleGet(...)

MkLogFileC - Introspection - overload
#define	MkLogFileInstances_NULL()
#define	MkLogFileInstances()

Detailed Description

MkLogFileC - define the class …

Macro Definition Documentation

MkLogFileHandleGet

#define MkLogFileHandleGet

(

...

)

Value:

MkLogFileHandleGet_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 1420 of file kernel_overload_mk.h.

MkLogFileHandleGet_NULL

#define MkLogFileHandleGet_NULL

(

...

)

Value:

MkLogFileHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1419 of file kernel_overload_mk.h.

MkLogFileHandleResolve

#define MkLogFileHandleResolve

(

...

)

Value:

MkLogFileHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 1416 of file kernel_overload_mk.h.

MkLogFileHandleResolve_e

#define MkLogFileHandleResolve_e

(

netHdl

)

Value:

  ({ \
  MK_HDL tmpHdl=netHdl; \
  MK_LFL tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=MkLogFileHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'MkLogFileC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

wrapper for MkLogFileHandleResolve with error-handline

Parameters

[in]

netHdl

The handle previously returned by MkObjectHandleGet.

Returns

Return an valid MK_LFL 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.
• MkLogFileHandleResolve return an valid MK_LFL 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 MK_LFL is returned than the netHdl is valid.

Definition at line 9029 of file LibMkKernel_mk.h.

#define MkLogFileHandleResolve_e(netHdl) ({ \
  MK_HDL tmpHdl=netHdl; \
  MK_LFL tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=MkLogFileHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'MkLogFileC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

MkLogFileHandleResolve_NULL

#define MkLogFileHandleResolve_NULL

(

...

)

Value:

MkLogFileHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 1415 of file kernel_overload_mk.h.

MkLogFileInstances

#define MkLogFileInstances

(

)

Value:

MkLogFileInstances_RT(MK_RT_CALL_ONLY)

Definition at line 1431 of file kernel_overload_mk.h.

MkLogFileInstances_NULL

#define MkLogFileInstances_NULL

(

)

Value:

MkLogFileInstances_RT(MK_RT_CALL_NULL_ONLY)

Definition at line 1430 of file kernel_overload_mk.h.

Typedef Documentation

MK_LFL

typedef struct MkLogFileS* MK_LFL

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

Definition at line 1480 of file LibMkKernel_mk.h.

MK_LFLN

typedef const struct MkLogFileS* MK_LFLN

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

Definition at line 1483 of file LibMkKernel_mk.h.

MK_LFLR

typedef struct MkLogFileS MK_LFLR

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

Definition at line 1486 of file LibMkKernel_mk.h.

Function Documentation

MkLogFileGetNull()

static MK_LFL MkLogFileGetNull ( void )

inlinestatic

Null-Slot - return a MkLogFileC typed NULL instance …

Definition at line 9054 of file LibMkKernel_mk.h.

                                             {
    return (MK_LFL)MK_NULL;
  }

MkLogFileGetNullP()

MK_LFL MkLogFileGetNullP

(

void

)

Non-inline replacement for MkLogFileGetNull …

MkLogFileHandleGet_RT()

static MK_HDL MkLogFileHandleGet_RT ( MK_RT mkrt, MK_LFL const lfl )

inlinestatic

Handle-Get-Slot - returns a export-hdl to the MkLogFileC 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 MkLogFileHandleResolve.

By default, the export-hdl is initialized to "0", which is equivalent to does not exist. This function returns a non-zero and unique export-hdl that is recreated if necessary.

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]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	lfl	the MkLogFileS instance to work on

Returns

the required export-hdl

Definition at line 8996 of file LibMkKernel_mk.h.

  {
  return MkObjectHandleGet(lfl?MkOBJ(lfl):NULL);
}

MkLogFileHandleGetP()

MK_HDL MkLogFileHandleGetP	(	MK_RT	mkrt,
		MK_LFL const	lfl )

Non-inline replacement for MkLogFileHandleGet …

MkLogFileHandleResolve_RT()

static MK_LFL MkLogFileHandleResolve_RT ( MK_RT mkrt, MK_HDL const netHdl )

inlinestatic

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

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

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	netHdl	handle former exported with MkLogFileHandleGet

Returns

the required handle or MK_NULL if netHdl is invalid

Definition at line 9013 of file LibMkKernel_mk.h.

  {
  return MkLfl(MkObjectHandleResolve(netHdl));
}

MkLogFileHandleResolveP()

MK_LFL MkLogFileHandleResolveP	(	MK_RT	mkrt,
		MK_HDL const	netHdl )

Non-inline replacement for MkLogFileHandleResolve …

MkLogFileInstances_RT()

static MK_LFL MkLogFileInstances_RT ( MK_RT mkrt )

inlinestatic

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

The head-instance is the last instance created.

Definition at line 12792 of file LibMkKernel_mk.h.

                                                            {
  MK_STATIC_RT;
  return (MK_LFL)MkLogFileC_TT->instances;
}

MkLogFileInstancesP()

MK_LFL MkLogFileInstancesP

(

MK_RT

mkrt

)

Non-inline replacement for MkLogFileInstances …

MkLogFileNext()

static MK_LFL MkLogFileNext ( MK_LFL const lfl )

inlinestatic

get next instance from linked-list of MkLogFileS type

Definition at line 12799 of file LibMkKernel_mk.h.

                                                 {
  MK_INSTANCE_HDL(lfl);
  return (MK_LFL)MkLogFileC_X2obj(lfl)->obj_protect.next;
}

MkLogFileNextP()

MK_LFL MkLogFileNextP

(

MK_LFL const

lfl

)

Non-inline replacement for MkLogFileNext …

MkLogFilePrev()

static MK_LFL MkLogFilePrev ( MK_LFL const lfl )

inlinestatic

get previous instance from linked-list of MkLogFileS type

Definition at line 12806 of file LibMkKernel_mk.h.

                                                 {
  MK_INSTANCE_HDL(lfl);
  return (MK_LFL)MkLogFileC_X2obj(lfl)->obj_protect.prev;
}

MkLogFilePrevP()

MK_LFL MkLogFilePrevP

(

MK_LFL const

lfl

)

Non-inline replacement for MkLogFilePrev …