X-shooter Pipeline Reference Manual 3.8.15
Macros
Xshooter error handling

Macros

#define assure(CONDITION, ERROR_CODE, ...)    irplib_error_assure(CONDITION, ERROR_CODE, (__VA_ARGS__), goto cleanup)
 
#define assure_nomsg(BOOL, CODE)    assure(BOOL, CODE, " ")
 
#define check_msg(COMMAND, ...)
 
#define check(COMMAND)   check_msg(COMMAND, " ")
 
#define cknull_msg(NULLEXP, ...)
 
#define cknull(NULLEXP)   cknull_msg(NULLEXP," ")
 
#define assure_mem(PTR)    assure((PTR) != NULL, CPL_ERROR_ILLEGAL_OUTPUT, "Memory allocation failure!")
 
#define passure(CONDITION, ...)
 
#define xsh_error_reset()   xsh_irplib_error_reset()
 
#define xsh_error_dump(level)   irplib_error_dump(level, level)
 
#define xsh_error_msg(...)
 
#define XSH_ASSURE_NOT_NULL(pointer)
 
#define XSH_ASSURE_NOT_NULL_MSG(pointer, msg)
 
#define XSH_ASSURE_NOT_ILLEGAL(cond)
 
#define XSH_ASSURE_NOT_ILLEGAL_MSG(cond, msg)
 
#define XSH_ASSURE_NOT_MISMATCH(cond)
 
#define XSH_CMP_INT(A, OPERATOR, B, SUFFIX, ...)
 
#define XSH_CHECK_COND(A, OPERATOR, B, SUFFIX, ...)
 
#define XSH_CHECK_FRAMESET_SIZE(FRAMESET, OPERATOR, SIZE)
 
#define XSH_REGDEBUG(...)    xsh_msg_debug("<< REGDEBUG >> :" __VA_ARGS__)
 

Detailed Description

Macro Definition Documentation

◆ assure

#define assure (   CONDITION,
  ERROR_CODE,
  ... 
)     irplib_error_assure(CONDITION, ERROR_CODE, (__VA_ARGS__), goto cleanup)

Definition at line 54 of file xsh_error.h.

◆ assure_mem

#define assure_mem (   PTR)     assure((PTR) != NULL, CPL_ERROR_ILLEGAL_OUTPUT, "Memory allocation failure!")

Definition at line 79 of file xsh_error.h.

◆ assure_nomsg

#define assure_nomsg (   BOOL,
  CODE 
)     assure(BOOL, CODE, " ")

Condition

Definition at line 58 of file xsh_error.h.

◆ check

#define check (   COMMAND)    check_msg(COMMAND, " ")

Definition at line 71 of file xsh_error.h.

◆ check_msg

#define check_msg (   COMMAND,
  ... 
)
Value:
irplib_error_assure((cpl_msg_indent_more(), \
(COMMAND), \
cpl_msg_indent_less(), \
cpl_error_get_code() == CPL_ERROR_NONE), \
cpl_error_get_code(), \
(__VA_ARGS__), goto cleanup)
#define irplib_error_assure(CONDITION, ERROR_CODE, MSG, ACTION)
Generic error handling macro.
Definition: irplib_error.h:155

Definition at line 62 of file xsh_error.h.

◆ cknull

#define cknull (   NULLEXP)    cknull_msg(NULLEXP," ")

Definition at line 77 of file xsh_error.h.

◆ cknull_msg

#define cknull_msg (   NULLEXP,
  ... 
)
Value:
cpl_error_ensure((NULLEXP) != NULL, \
CPL_ERROR_UNSPECIFIED, goto cleanup,__VA_ARGS__)

Definition at line 73 of file xsh_error.h.

◆ passure

#define passure (   CONDITION,
  ... 
)
Value:
assure(CONDITION, CPL_ERROR_UNSPECIFIED, \
"Internal program error. Please report to " \
PACKAGE_BUGREPORT " " __VA_ARGS__)
#define assure(CONDITION, ERROR_CODE,...)
Definition: xsh_error.h:54

Definition at line 82 of file xsh_error.h.

◆ XSH_ASSURE_NOT_ILLEGAL

#define XSH_ASSURE_NOT_ILLEGAL (   cond)
Value:
assure(cond, CPL_ERROR_ILLEGAL_INPUT,\
"condition failed: " #cond )

Definition at line 107 of file xsh_error.h.

◆ XSH_ASSURE_NOT_ILLEGAL_MSG

#define XSH_ASSURE_NOT_ILLEGAL_MSG (   cond,
  msg 
)
Value:
assure(cond, CPL_ERROR_ILLEGAL_INPUT,\
"condition failed: " #cond "\n" msg)

Definition at line 111 of file xsh_error.h.

◆ XSH_ASSURE_NOT_MISMATCH

#define XSH_ASSURE_NOT_MISMATCH (   cond)
Value:
assure(cond, CPL_ERROR_TYPE_MISMATCH,\
"condition failed: "#cond )

Definition at line 115 of file xsh_error.h.

◆ XSH_ASSURE_NOT_NULL

#define XSH_ASSURE_NOT_NULL (   pointer)
Value:
assure(pointer != NULL, CPL_ERROR_NULL_INPUT,\
"You have null pointer in input: " #pointer)

Definition at line 99 of file xsh_error.h.

◆ XSH_ASSURE_NOT_NULL_MSG

#define XSH_ASSURE_NOT_NULL_MSG (   pointer,
  msg 
)
Value:
assure(pointer != NULL, CPL_ERROR_NULL_INPUT,\
"You have null pointer in input: " #pointer "\n" msg)

Definition at line 103 of file xsh_error.h.

◆ XSH_CHECK_COND

#define XSH_CHECK_COND (   A,
  OPERATOR,
  B,
  SUFFIX,
  ... 
)
Value:
assure(A OPERATOR B, CPL_ERROR_ILLEGAL_INPUT,\
"assertion failed: %s %s %s\n" #SUFFIX "", #A, #OPERATOR, #B, __VA_ARGS__)

Definition at line 124 of file xsh_error.h.

◆ XSH_CHECK_FRAMESET_SIZE

#define XSH_CHECK_FRAMESET_SIZE (   FRAMESET,
  OPERATOR,
  SIZE 
)
Value:
XSH_CHECK_COND(cpl_frameset_get_size(FRAMESET),OPERATOR,SIZE,\
"%s","Frameset size invalid:")
#define XSH_CHECK_COND(A, OPERATOR, B, SUFFIX,...)
Definition: xsh_error.h:124

Definition at line 128 of file xsh_error.h.

◆ XSH_CMP_INT

#define XSH_CMP_INT (   A,
  OPERATOR,
  B,
  SUFFIX,
  ... 
)
Value:
assure(A OPERATOR B, CPL_ERROR_ILLEGAL_INPUT,\
"assertion failed: %s %s %s : %d %s %d\n"\
#SUFFIX "", #A, #OPERATOR, #B , A, #OPERATOR, B __VA_ARGS__)

Definition at line 119 of file xsh_error.h.

◆ xsh_error_dump

#define xsh_error_dump (   level)    irplib_error_dump(level, level)

Definition at line 92 of file xsh_error.h.

◆ xsh_error_msg

#define xsh_error_msg (   ...)
Value:
if(cpl_error_get_code()!= CPL_ERROR_NULL_INPUT){\
irplib_error_push(cpl_error_get_code(), (__VA_ARGS__));\
}

Definition at line 94 of file xsh_error.h.

◆ xsh_error_reset

#define xsh_error_reset ( )    xsh_irplib_error_reset()

Definition at line 87 of file xsh_error.h.

◆ XSH_REGDEBUG

#define XSH_REGDEBUG (   ...)     xsh_msg_debug("<< REGDEBUG >> :" __VA_ARGS__)

Definition at line 132 of file xsh_error.h.