MkErrorC_Misc_TCL_API

MkErrorC - various functions to 'work' on a MkErrorS … More...

Collaboration diagram for MkErrorC_Misc_TCL_API:

Functions
static OT_ProcRet	tclmkkernel_MkErrorC_Catch (MkErrorC_ARGS)
	Tcl: MkErrorC [$err Catch ?exception:errorCode="MK_NULL"? ?callfunc:string="MK_NULL"?] → C-API convert a programming-language-error into an tclmkkernel error …
static OT_ProcRet	tclmkkernel_MkErrorC_Cleanup (MkErrorC_ARGS)
	Tcl: $err Cleanup ?callfunc:string="MK_NULL"? ?callline:int32=-1? → C-API cleanup and print unwanted active error …
MK_DEPRECATED static MK_UNUSED OT_ProcRet	tclmkkernel_MkErrorC_Log (MkErrorC_ARGS)
static OT_ProcRet	tclmkkernel_MkErrorC_Println (MkErrorC_ARGS)
	Tcl: $err Println ?msg:string=""? ?callfunc:string="MK_NULL"? ?callline:int32=-1? → C-API print the default-error to the MkLogFileC (default: stderr) and clear the error afterwards …
static OT_ProcRet	tclmkkernel_MkErrorC_Reset (MkErrorC_ARGS)
	Tcl: $err Reset ?callfunc:string="MK_NULL"? ?callline:int32=-1? ?force:bool=false? → C-API This function clears the err and resets to MK_OK …
static OT_ProcRet	tclmkkernel_MkErrorC_Stack (MkErrorC_ARGS)
	Tcl: MkErrorE [$err Stack ?callfunc:string="MK_NULL"? ?callfile:string="MK_NULL"? ?callline:int32=-1?] → C-API check on error and if yes append an ErrorStackFormat to the error-message …
static OT_ProcRet	tclmkkernel_MkErrorC_StackFormat (MkErrorC_ARGS)
	Tcl: $err StackFormat ?callfunc:string="MK_NULL"? ?callfile:string="MK_NULL"? ?callline:int32=-1? → C-API append an ensemble of func, file and line to the error-message …
MK_DEPRECATED static MK_UNUSED OT_ProcRet	tclmkkernel_MkErrorC_ToString (MkErrorC_ARGS)

Detailed Description

MkErrorC - various functions to 'work' on a MkErrorS …

Function Documentation

tclmkkernel_MkErrorC_Catch()

static OT_ProcRet tclmkkernel_MkErrorC_Catch ( MkErrorC_ARGS )

static

Tcl: MkErrorC [$err Catch ?exception:errorCode="MK_NULL"? ?callfunc:string="MK_NULL"?] → C-API
convert a programming-language-error into an tclmkkernel error …

Definition at line 363 of file MkErrorC_tcl.c.

                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,2,Catch_doc);
  MK_EXP exception = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_EXP (exception))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  OT_CHECK_NOARGS;
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MK_ERR retVal = MkErrorCatchTmpl (hdl, exception, callfunc);
  OT_retObj_SET_ERR(retVal);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_Cleanup()

static OT_ProcRet tclmkkernel_MkErrorC_Cleanup ( MkErrorC_ARGS )

static

Tcl: $err Cleanup ?callfunc:string="MK_NULL"? ?callline:int32=-1? → C-API
cleanup and print unwanted active error …

Definition at line 385 of file MkErrorC_tcl.c.

                                                       {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,2,Cleanup_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 callline = -1;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (callline))
  OT_CHECK_NOARGS;
  if (callline == -1 ) {callline = OT_GET_CALL_LINE;}
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorCleanup (hdl, callfunc, callline);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_Log()

MK_DEPRECATED static MK_UNUSED OT_ProcRet tclmkkernel_MkErrorC_Log ( MkErrorC_ARGS )

static

Definition at line 407 of file MkErrorC_tcl.c.

{OT_ERROR_LNG_RETURN;}

tclmkkernel_MkErrorC_Println()

static OT_ProcRet tclmkkernel_MkErrorC_Println ( MkErrorC_ARGS )

static

Tcl: $err Println ?msg:string=""? ?callfunc:string="MK_NULL"? ?callline:int32=-1? → C-API
print the default-error to the MkLogFileC (default: stderr) and clear the error afterwards …

Definition at line 410 of file MkErrorC_tcl.c.

                                                       {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,3,Println_doc);
  MK_STRN msg = "";
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (msg))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 callline = -1;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (callline))
  OT_CHECK_NOARGS;
  if (callline == -1 ) {callline = OT_GET_CALL_LINE;}
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorPrintln (hdl, msg, callfunc, callline);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_Reset()

static OT_ProcRet tclmkkernel_MkErrorC_Reset ( MkErrorC_ARGS )

static

Tcl: $err Reset ?callfunc:string="MK_NULL"? ?callline:int32=-1? ?force:bool=false? → C-API
This function clears the err and resets to MK_OK …

Definition at line 433 of file MkErrorC_tcl.c.

                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,3,Reset_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 callline = -1;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (callline))
  MK_BOOL force = false;
  OT_CHECK_OPTIONAL(OT_CHECK_bool (force))
  OT_CHECK_NOARGS;
  if (callline == -1 ) {callline = OT_GET_CALL_LINE;}
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorC_Check(hdl,MkErrorReset (hdl, callfunc, callline, force));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_Stack()

static OT_ProcRet tclmkkernel_MkErrorC_Stack ( MkErrorC_ARGS )

static

Tcl: MkErrorE [$err Stack ?callfunc:string="MK_NULL"? ?callfile:string="MK_NULL"? ?callline:int32=-1?] → C-API
check on error and if yes append an ErrorStackFormat to the error-message …

Definition at line 456 of file MkErrorC_tcl.c.

                                                     {
  OT_SETUP_hdl__null_allow;
  OT_SETUP_VARARGS(0,3,Stack_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_STRN callfile = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfile))
  MK_I32 callline = -1;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (callline))
  OT_CHECK_NOARGS;
  if (callline == -1 ) {callline = OT_GET_CALL_LINE;}
  if (MkSysStringIsNULL(callfile)) {callfile = OT_GET_CALL_FILE;}
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  OT_retObj_SET(OT_NEW_Mk_enum_OBJ(ErrorE,MkErrorStack (hdl, callfunc, callfile, callline)));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_StackFormat()

static OT_ProcRet tclmkkernel_MkErrorC_StackFormat ( MkErrorC_ARGS )

static

Tcl: $err StackFormat ?callfunc:string="MK_NULL"? ?callfile:string="MK_NULL"? ?callline:int32=-1? → C-API
append an ensemble of func, file and line to the error-message …

Definition at line 479 of file MkErrorC_tcl.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,3,StackFormat_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_STRN callfile = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfile))
  MK_I32 callline = -1;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (callline))
  OT_CHECK_NOARGS;
  if (callline == -1 ) {callline = OT_GET_CALL_LINE;}
  if (MkSysStringIsNULL(callfile)) {callfile = OT_GET_CALL_FILE;}
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorStackFormat (hdl, callfunc, callfile, callline);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_ToString()

MK_DEPRECATED static MK_UNUSED OT_ProcRet tclmkkernel_MkErrorC_ToString ( MkErrorC_ARGS )

static

Definition at line 504 of file MkErrorC_tcl.c.

{OT_ERROR_LNG_RETURN;}