LcConfig_Error_C_API

LcConfig PACKAGE - error handling in cslcconfig … More...

Collaboration diagram for LcConfig_Error_C_API:

Macros
#define	LcErrorCheckI(ret)
	check if ret signal an error …
#define	LcErrorE_Check(lc_hdl, PROC)
	check on a cslcconfig error and convert into a cslcconfig error …

Typedefs
typedef enum LcErrorE	LcErrorE
	define the return-code of a method-call …
typedef enum LcErrorTypeE	LcErrorTypeE
	define the error-source of a LcConfigC …

Functions
enum MkErrorE	LcConfigErrorToMQ (MK_OBJN const obj, MK_STRN const func, MK_STRN const file, MK_I32 const line)
	if a libconfig funtion return a LcErrorE use this function to convert the libconfig-error into the libmkkernel-error …

Detailed Description

LcConfig PACKAGE - error handling in cslcconfig …

The error signals the end of an operation with an undesirable result or state.

• The error is defined using the both enum: enum LcErrorE and enum LcErrorTypeE
• In a programming language WITHOUT explicit error handling (eg "C") this value is returned and the subsequent code must process the error, eg with LcErrorE_Check.
• In a programming language WITH explicit error handling (eg "Java"), the error is converted into an exception and the program flow is aborted with an error message.

Macro Definition Documentation

LcErrorCheckI

#define LcErrorCheckI

(

ret

)

Value:

((ret) == CONFIG_FALSE)

check if ret signal an error …

Parameters

[in]

ret

input for cslcconfig error-check

Returns

true if ret is an error otherwise false

Definition at line 362 of file LibLcConfig_lc.h.

LcErrorE_Check

#define LcErrorE_Check	(		lc_hdl,
			PROC )

Value:

  if (unlikely(LcErrorCheckI(PROC))) {                              \
    LcConfigErrorToMQ(MkOBJ(lc_hdl), __func__,__FILE__,__LINE__);    \
    goto error;                                                      \
  }

check on a cslcconfig error and convert into a cslcconfig error …

Parameters

[in]	lc_hdl	the instance to work on, LcConfigC or LcSettingC
[in]	PROC	the function to return the error, only eval once.

Returns

on error jump to label error:

Definition at line 370 of file LibLcConfig_lc.h.

#define LcErrorE_Check(lc_hdl,PROC)                                  \
  if (unlikely(LcErrorCheckI(PROC))) {                              \
    LcConfigErrorToMQ(MkOBJ(lc_hdl), __func__,__FILE__,__LINE__);    \
    goto error;                                                      \
  }

Typedef Documentation

LcErrorE

typedef enum LcErrorE LcErrorE

define the return-code of a method-call …

enum LcErrorE {
  CONFIG_FALSE=0,
  CONFIG_TRUE=1,
};

Definition at line 348 of file LibLcConfig_lc.h.

LcErrorTypeE

typedef enum LcErrorTypeE LcErrorTypeE

define the error-source of a LcConfigC …

enum LcErrorTypeE {
  CONFIG_ERRROR_NONE = 0,
  CONFIG_ERRROR_FILE_IO = 1,
  CONFIG_ERRROR_PARSE = 2
};

See also

ConfigErrorType ErrorTypeE_ToString

Definition at line 355 of file LibLcConfig_lc.h.

Function Documentation

LcConfigErrorToMQ()

enum MkErrorE LcConfigErrorToMQ	(	MK_OBJN const	obj,
		MK_STRN const	func,
		MK_STRN const	file,
		MK_I32 const	line )

if a libconfig funtion return a LcErrorE use this function to convert the libconfig-error into the libmkkernel-error …