Sq3Lite_Error_C_API

Sq3Lite PACKAGE - work with an error … More...

Collaboration diagram for Sq3Lite_Error_C_API:

Macros
#define	Sq3ErrorE_Check(sq3_hdl, PROC)
	check on a ccsq3lite error and convert into a ccsq3lite error …
#define	Sq3ErrorE_Check_Package(PROC)
#define	Sq3ErrorE_Check_Static(cls_hdl, PROC)
#define	Sq3ErrorE_Check_Ctor(__cls, __hdl, PROC)

Functions
static bool	libsq3lite::Sq3ErrorCheckI (enum Sq3ErrorE ret)
	check if ret signal an error …
enum MkErrorE	libsq3lite::Sq3LiteErrorToMQ (MK_OBJN const obj, MK_STRN const func, MK_STRN const file, MK_I32 const line)
	if a ccsq3lite funtion return a MkErrorE use this function to convert the libsq3lite-error into the libmkkernel-error …

Detailed Description

Sq3Lite PACKAGE - work with an error …

Error handling in ccsq3lite.

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

• The error is defined using the both enum: enum libsq3lite::Sq3ErrorE and enum libsq3lite::Sq3ExtendetResultCodesE
• In a programming language WITHOUT explicit error handling (eg "C") this value is returned and the subsequent code must process the error, eg with Sq3ErrorE_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

Sq3ErrorE_Check

#define Sq3ErrorE_Check	(		sq3_hdl,
			PROC )

Value:

  if (unlikely(Sq3ErrorCheckI(PROC))) {                                \
    Sq3LiteErrorToMQ(MkOBJ(sq3_hdl), __func__,__FILE__,__LINE__);   \
    goto error;                                                        \
  }                                                                    \

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

Parameters

[in]	sq3_hdl	the instance to work on CLASS
[in]	PROC	the function to return the error, only eval once.

Returns

on error jump to label error:

Definition at line 473 of file LibSq3Lite_sq3.h.

    Sq3LiteErrorToMQ(MkOBJ(cls_hdl), __func__,__FILE__,__LINE__);    \
    goto error;                                                         \
  }
 
#define Sq3ErrorE_Check_Ctor(__cls, __hdl, PROC)                                       \
  if (unlikely(Sq3ErrorCheckI(PROC))) {                                                \

Sq3ErrorE_Check_Ctor

#define Sq3ErrorE_Check_Ctor	(		__cls,
			__hdl,
			PROC )

Value:

  if (unlikely(Sq3ErrorCheckI(PROC))) {                                                \
    Sq3LiteErrorToMQ(__hdl?MkOBJ(__hdl):MkOBJ(__cls), __func__,__FILE__,__LINE__);  \
    goto error;                                                                        \
  }

Definition at line 491 of file LibSq3Lite_sq3.h.

 
__parser__(hide,overload-c-no,class=Sq3Lite)
SQ3_EXTERN enum MkErrorE MK_DECL
Sq3LiteErrorToMQ (
  MK_OBJN const obj,

Sq3ErrorE_Check_Package

#define Sq3ErrorE_Check_Package

(

PROC

)

Value:

  if (unlikely(Sq3ErrorCheckI(PROC))) {                                 \
    Sq3LiteErrorToMQ(MK_ERROR_DEFAULT_NULL, __func__,__FILE__,__LINE__);                  \
    goto error;                                                         \
  }

Definition at line 479 of file LibSq3Lite_sq3.h.

    Sq3LiteErrorToMQ(__hdl?MkOBJ(__hdl):MkOBJ(__cls), __func__,__FILE__,__LINE__);  \
    goto error;                                                                        \
  }
 
// fix non common name

Sq3ErrorE_Check_Static

#define Sq3ErrorE_Check_Static	(		cls_hdl,
			PROC )

Value:

  if (unlikely(Sq3ErrorCheckI(PROC))) {                                 \
    Sq3LiteErrorToMQ(MkOBJ(cls_hdl), __func__,__FILE__,__LINE__);    \
    goto error;                                                         \
  }

Definition at line 485 of file LibSq3Lite_sq3.h.

// add new meta-name with: typedef config_error_t Sq3ErrorE;
 
// ------------------------------------------------------------------
// error
 

Function Documentation

Sq3ErrorCheckI()

static bool libsq3lite::Sq3ErrorCheckI ( enum Sq3ErrorE ret )

inlinestatic

check if ret signal an error …

Parameters

[in]

ret

input for ccsq3lite error-check

Returns

true if ret is an error otherwise false

Definition at line 463 of file LibSq3Lite_sq3.h.

Here is the caller graph for this function:

Sq3LiteErrorToMQ()

enum MkErrorE libsq3lite::Sq3LiteErrorToMQ	(	MK_OBJN const	obj,
		MK_STRN const	func,
		MK_STRN const	file,
		MK_I32 const	line )

if a ccsq3lite funtion return a MkErrorE use this function to convert the libsq3lite-error into the libmkkernel-error …