Collaboration diagram for LcSettingC_Class_C_API:

Topics
	LcSettingC_Class_Define_C_API
	LcSettingC - low level definition, access and cast …

Macros
#define	LcGetCfsFromNat(_nat)
	helper for LcSettingC_ObjNew …

Typedefs
typedef struct LcSettingS *	LC_CFS
	class-shortcut for `struct LcSettingS *`, all shortcut using the `XX_YYY` syntax (only for public API) …

typedef const struct LcSettingS *	LC_CFSN
	class-shortcut for `const struct LcSettingS `, all const* shortcut using the `XX_YYYC` syntax (only for public API) …

typedef struct LcSettingS	LC_CFSR
	reference-shortcut for `struct LcSettingS`, all shortcut using the `XX_YYYR` syntax (only for public API) …

LcSettingC - Export - inline - interact with an external software
MK_ARTIFICIAL LC_CFS	LcSettingC_ObjNew (config_setting_t *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native *hdl* …

LC_CFS	LcSettingC_ObjCreate (config_setting_t *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native *hdl* …

MK_HDL	LcSettingHandleGet_RT (MK_RT mkrt, LC_CFS const cfs)
	Handle-Get-Slot - returns a *export-hdl* to the LcSettingC useable for external storage

LC_CFS	LcSettingHandleResolve_RT (MK_RT mkrt, MK_HDL const netHdl)
	Handle-Resolve-Slot - return a LcSettingC from *netHdl* or `MK_NULL` if invalid…

#define	LcSettingHandleResolve_e(netHdl)
	wrapper for LcSettingHandleResolve with error-handline

LcSettingC - Misc - function - unspecified functions to perform different tasks
LC_CFS	LcSettingGetNull (void)
	Null-Slot - return a LcSettingC typed `NULL` instance …

LcSettingC - Introspection - inline - access to all instances created by class starting with the last one
LC_CFS	LcSettingInstances_RT (MK_PARSER_RT_ONLY)
	get head-instance from linked-list of LcSettingS type …

LC_CFS	LcSettingNext (LC_CFS const cfs)
	get next instance from linked-list of LcSettingS type

LC_CFS	LcSettingPrev (LC_CFS const cfs)
	get previous instance from linked-list of LcSettingS type

LcSettingC - Export - function
LC_EXTERN LC_CFS	LcSettingHandleResolveP (MK_RT mkrt, MK_HDL const netHdl)
	Non-inline replacement for LcSettingHandleResolve …

LC_EXTERN MK_HDL	LcSettingHandleGetP (MK_RT mkrt, LC_CFS const cfs)
	Non-inline replacement for LcSettingHandleGet …

LcSettingC - Introspection - function
LC_EXTERN LC_CFS	LcSettingNextP (LC_CFS const cfs)
	Non-inline replacement for LcSettingNext …

LC_EXTERN LC_CFS	LcSettingPrevP (LC_CFS const cfs)
	Non-inline replacement for LcSettingPrev …

LC_EXTERN LC_CFS	LcSettingInstancesP (MK_PARSER_RT_ONLY)
	Non-inline replacement for LcSettingInstances …

LcSettingC - Misc - function
LC_EXTERN LC_CFS	LcSettingGetNullP (void)
	Non-inline replacement for LcSettingGetNull …

LcSettingC - Export - overload
#define	LcSettingHandleResolve_NULL(...)

#define	LcSettingHandleResolve(...)

#define	LcSettingHandleGet_NULL(...)

#define	LcSettingHandleGet(...)

LcSettingC - Introspection - overload
#define	LcSettingInstances_NULL()

#define	LcSettingInstances()

Detailed Description

LcSettingC - define the class …

Macro Definition Documentation

◆ LcGetCfsFromNat

#define LcGetCfsFromNat ( _nat )

Value:

LC_SET_T(LcSettingC,config_setting_get_hook,_nat)

LC_SET_T

#define LC_SET_T(_cls, _hook, _nat)

Definition LibLcConfig_lc.h:294

config_setting_get_hook

#define config_setting_get_hook(S)

Definition libconfig_modified.h:312

helper for LcSettingC_ObjNew …

Definition at line 204 of file LcSettingC_def_lc.h.

◆ LcSettingHandleGet

#define LcSettingHandleGet ( ... )

Value:

LcSettingHandleGet_RT(MK_RT_CALL __VA_ARGS__)

LcSettingHandleGet_RT

MK_HDL LcSettingHandleGet_RT(MK_RT mkrt, LC_CFS const cfs)

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

Definition LcSettingC_def_lc.h:246

MK_RT_CALL

#define MK_RT_CALL

Definition at line 168 of file config_overload_lc.h.

◆ LcSettingHandleGet_NULL

#define LcSettingHandleGet_NULL ( ... )

Value:

LcSettingHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 167 of file config_overload_lc.h.

◆ LcSettingHandleResolve

#define LcSettingHandleResolve ( ... )

Value:

LcSettingHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

LcSettingHandleResolve_RT

LC_CFS LcSettingHandleResolve_RT(MK_RT mkrt, MK_HDL const netHdl)

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

Definition LcSettingC_def_lc.h:263

Definition at line 164 of file config_overload_lc.h.

◆ LcSettingHandleResolve_e

#define LcSettingHandleResolve_e ( netHdl )

Value:

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

wrapper for LcSettingHandleResolve with error-handline

Parameters

[in] netHdl The handle previously returned by MkObjectHandleGet.

Returns: Return an valid LC_CFS 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.
LcSettingHandleResolve return an valid LC_CFS 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 LC_CFS is returned than the netHdl is valid.

Definition at line 279 of file LcSettingC_def_lc.h.

#define LcSettingHandleResolve_e(netHdl) ({ \
  MK_HDL tmpHdl=netHdl; \
  LC_CFS tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=LcSettingHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'LcSettingC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

◆ LcSettingHandleResolve_NULL

#define LcSettingHandleResolve_NULL ( ... )

Value:

LcSettingHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 163 of file config_overload_lc.h.

◆ LcSettingInstances

#define LcSettingInstances ( )

Value:

LcSettingInstances_RT(MK_RT_CALL_ONLY)

LcSettingInstances_RT

LC_CFS LcSettingInstances_RT(MK_PARSER_RT_ONLY)

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

Definition LcSettingC_def_lc.h:328

MK_RT_CALL_ONLY

#define MK_RT_CALL_ONLY

Definition at line 179 of file config_overload_lc.h.

◆ LcSettingInstances_NULL

#define LcSettingInstances_NULL ( )

Value:

LcSettingInstances_RT(MK_RT_CALL_NULL_ONLY)

MK_RT_CALL_NULL_ONLY

#define MK_RT_CALL_NULL_ONLY

Definition at line 178 of file config_overload_lc.h.

Typedef Documentation

◆ LC_CFS

typedef struct LcSettingS* LC_CFS

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

Definition at line 335 of file LibLcConfig_lc.h.

◆ LC_CFSN

typedef const struct LcSettingS* LC_CFSN

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

Definition at line 338 of file LibLcConfig_lc.h.

◆ LC_CFSR

typedef struct LcSettingS LC_CFSR

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

Definition at line 341 of file LibLcConfig_lc.h.

Function Documentation

◆ LcSettingC_ObjCreate()

LC_CFS LcSettingC_ObjCreate ( config_setting_t * hdl )

inline

return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …

Definition at line 227 of file LcSettingC_def_lc.h.

                                                                                              {
  MkRtSetup_NULL;
  return LcGetCfsFromNat(hdl);
}

Here is the caller graph for this function:

◆ LcSettingC_ObjNew()

MK_ARTIFICIAL LC_CFS LcSettingC_ObjNew ( config_setting_t * hdl )

inline

return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …

Definition at line 220 of file LcSettingC_def_lc.h.

                                                                                           {
  MkRtSetup_NULL;
  return LcGetCfsFromNat(hdl);
}

Here is the caller graph for this function:

◆ LcSettingGetNull()

LC_CFS LcSettingGetNull ( void )

inline

Null-Slot - return a LcSettingC typed NULL instance …

Definition at line 304 of file LcSettingC_def_lc.h.

                                             {
    return (LC_CFS)MK_NULL;
  }

◆ LcSettingGetNullP()

LC_EXTERN LC_CFS LcSettingGetNullP ( void )

Non-inline replacement for LcSettingGetNull …

◆ LcSettingHandleGet_RT()

MK_HDL LcSettingHandleGet_RT	(	MK_RT	mkrt,
		LC_CFS const	cfs )

inline

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

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]	cfs	Programming-Language-Micro-Kernel (PLMK) instance from config_setting_t

Returns: the required export-hdl

Definition at line 246 of file LcSettingC_def_lc.h.

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

◆ LcSettingHandleGetP()

LC_EXTERN MK_HDL LcSettingHandleGetP	(	MK_RT	mkrt,
		LC_CFS const	cfs )

Non-inline replacement for LcSettingHandleGet …

◆ LcSettingHandleResolve_RT()

LC_CFS LcSettingHandleResolve_RT	(	MK_RT	mkrt,
		MK_HDL const	netHdl )

inline

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

The LcSettingHandleResolve undo the LcSettingHandleGet 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 LcSettingHandleGet

Returns: the required handle or MK_NULL if netHdl is invalid

Definition at line 263 of file LcSettingC_def_lc.h.

  {
  return LcCfs(MkObjectHandleResolve(netHdl));
}

◆ LcSettingHandleResolveP()

LC_EXTERN LC_CFS LcSettingHandleResolveP	(	MK_RT	mkrt,
		MK_HDL const	netHdl )

Non-inline replacement for LcSettingHandleResolve …

◆ LcSettingInstances_RT()

LC_CFS LcSettingInstances_RT ( MK_PARSER_RT_ONLY )

inline

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

The head-instance is the last instance created.

Definition at line 328 of file LcSettingC_def_lc.h.

                                                            {
  LC_STATIC_RT;
  return (LC_CFS)LcSettingC_TT->instances;
}

◆ LcSettingInstancesP()

LC_EXTERN LC_CFS LcSettingInstancesP ( MK_PARSER_RT_ONLY )

Non-inline replacement for LcSettingInstances …

◆ LcSettingNext()

LC_CFS LcSettingNext ( LC_CFS const cfs )

inline

get next instance from linked-list of LcSettingS type

Definition at line 335 of file LcSettingC_def_lc.h.

                                                 {
  MK_INSTANCE_HDL(cfs);
  return (LC_CFS)LcSettingC_X2obj(cfs)->obj_protect.next;
}

◆ LcSettingNextP()

LC_EXTERN LC_CFS LcSettingNextP ( LC_CFS const cfs )

Non-inline replacement for LcSettingNext …

◆ LcSettingPrev()

LC_CFS LcSettingPrev ( LC_CFS const cfs )

inline

get previous instance from linked-list of LcSettingS type

Definition at line 342 of file LcSettingC_def_lc.h.

                                                 {
  MK_INSTANCE_HDL(cfs);
  return (LC_CFS)LcSettingC_X2obj(cfs)->obj_protect.prev;
}

◆ LcSettingPrevP()

LC_EXTERN LC_CFS LcSettingPrevP ( LC_CFS const cfs )

Non-inline replacement for LcSettingPrev …

Topics

Macros

Typedefs

LcSettingC - Export - inline - interact with an external software

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

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

LcSettingC - Export - function

LcSettingC - Introspection - function

LcSettingC - Misc - function

LcSettingC - Export - overload

LcSettingC - Introspection - overload

Detailed Description

Macro Definition Documentation

◆ LcGetCfsFromNat

◆ LcSettingHandleGet

◆ LcSettingHandleGet_NULL

◆ LcSettingHandleResolve

◆ LcSettingHandleResolve_e

◆ LcSettingHandleResolve_NULL

◆ LcSettingInstances

◆ LcSettingInstances_NULL

Typedef Documentation

◆ LC_CFS

◆ LC_CFSN

◆ LC_CFSR

Function Documentation

◆ LcSettingC_ObjCreate()

◆ LcSettingC_ObjNew()

◆ LcSettingGetNull()

◆ LcSettingGetNullP()

◆ LcSettingHandleGet_RT()

◆ LcSettingHandleGetP()

◆ LcSettingHandleResolve_RT()

◆ LcSettingHandleResolveP()

◆ LcSettingInstances_RT()

◆ LcSettingInstancesP()

◆ LcSettingNext()

◆ LcSettingNextP()

◆ LcSettingPrev()

◆ LcSettingPrevP()