IODA
Files | Macros
C++/C binding macros
IODA » Interfaces » C interface » API

Provides the C-style bindings for ioda's templated C++ classes and functions. More...

Collaboration diagram for C++/C binding macros:

Files

file  c_binding_macros.h
 C bindings interface to templated C++ ioda classes and functions.
 

Macros

#define C_TRY   try {
 Goes with C_CATCH_AND_TERMINATE. More...
 
#define C_CATCH_AND_TERMINATE
 Catch C++ exceptions before they go across code boundaries. More...
 
#define C_CATCH_AND_RETURN(retval_on_success, retval_on_error)
 This macro catches C++ exceptions. More...
 
#define C_CATCH_RETURN_FREE(retval_on_success, retval_on_error, freeable)
 Like C_CATCH_AND_RETURN, but free any in-function allocated C resource before returning to avoid memory leaks. More...
 
#define C_TEMPLATE_FUNCTION_DEFINITION(funcname, PATTERN)
 Used to expand templates to provide bindings for template-deprived languages (C, Fortran). More...
 
#define C_TEMPLATE_FUNCTION_DECLARATION(funcname, PATTERN)
 Used to expand templates to provide bindings for template-deprived languages (C, Fortran). More...
 
#define C_TEMPLATE_FUNCTION_DEFINITION_NOSTR(funcname, PATTERN)
 
#define C_TEMPLATE_FUNCTION_DECLARATION_4_NOSTR(shortname, basename, PATTERN)
 
#define C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR(shortname, basename, PATTERN)
 
#define C_TEMPLATE_FUNCTION_DECLARATION_3(shortname, basename, PATTERN)
 
#define C_TEMPLATE_FUNCTION_DECLARATION_NOSTR(funcname, PATTERN)    C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR(funcname, funcname, PATTERN)
 

Detailed Description

Provides the C-style bindings for ioda's templated C++ classes and functions.

Macro Definition Documentation

◆ C_CATCH_AND_RETURN

#define C_CATCH_AND_RETURN (   retval_on_success,
  retval_on_error 
)
Value:
return (retval_on_success); \
} \
catch (std::exception & e) { \
ioda::unwind_exception_stack(e); \
return retval_on_error; \
} \
catch (...) { \
std::terminate(); \
}
ioda::unwind_exception_stack
IODA_DL void unwind_exception_stack(const std::exception &e, std::ostream &out=std::cerr, int level=0)
Convenience function for unwinding an exception stack.
Definition: Exception.cpp:48

This macro catches C++ exceptions.

If they are recoverable, then return the error value. If nonrecoverable, behave as C_CATCH_AND_TERMINATE.

Definition at line 56 of file c_binding_macros.h.

◆ C_CATCH_AND_TERMINATE

#define C_CATCH_AND_TERMINATE
Value:
} \
catch (std::exception & e) { \
ioda::unwind_exception_stack(e); \
std::terminate(); \
} \
catch (...) { \
std::terminate(); \
}

Catch C++ exceptions before they go across code boundaries.

This is needed because exceptions are not supposed to propagate across language boundaries. Undefined behavior, and at best the program would terminate cleanly. This macro ensures that we call std::terminate, which calls std::abort, and prints an error indicating where this occurs.

See also
C_TRY for the other end of the block.

Definition at line 42 of file c_binding_macros.h.

◆ C_CATCH_RETURN_FREE

#define C_CATCH_RETURN_FREE (   retval_on_success,
  retval_on_error,
  freeable 
)
Value:
return (retval_on_success); \
} \
catch (std::exception & e) { \
ioda::unwind_exception_stack(e); \
delete freeable; \
return retval_on_error; \
} \
catch (...) { \
std::terminate(); \
}

Like C_CATCH_AND_RETURN, but free any in-function allocated C resource before returning to avoid memory leaks.

Definition at line 71 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DECLARATION

#define C_TEMPLATE_FUNCTION_DECLARATION (   funcname,
  PATTERN 
)
Value:
C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR(funcname, funcname, PATTERN) \
PATTERN(funcname##_str, funcname##_str)
C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR
#define C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR(shortname, basename, PATTERN)
Definition: c_binding_macros.h:139

Used to expand templates to provide bindings for template-deprived languages (C, Fortran).

Note
There is a similar macro in the ioda python interface.

Definition at line 166 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DECLARATION_3

#define C_TEMPLATE_FUNCTION_DECLARATION_3 (   shortname,
  basename,
  PATTERN 
)
Value:
C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR(shortname, basename, PATTERN) \
PATTERN(shortname##_str, basename##_str);

Definition at line 159 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR

#define C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR (   shortname,
  basename,
  PATTERN 
)
Value:
PATTERN(shortname##_float, basename##_float); \
PATTERN(shortname##_double, basename##_double); \
PATTERN(shortname##_ldouble, basename##_ldouble); \
PATTERN(shortname##_char, basename##_char); \
PATTERN(shortname##_short, basename##_short); \
PATTERN(shortname##_ushort, basename##_ushort); \
PATTERN(shortname##_int, basename##_int); \
PATTERN(shortname##_uint, basename##_uint); \
PATTERN(shortname##_lint, basename##_lint); \
PATTERN(shortname##_ulint, basename##_ulint); \
PATTERN(shortname##_llint, basename##_llint); \
PATTERN(shortname##_ullint, basename##_ullint); \
PATTERN(shortname##_int32, basename##_int32); \
PATTERN(shortname##_uint32, basename##_uint32); \
PATTERN(shortname##_int16, basename##_int16); \
PATTERN(shortname##_uint16, basename##_uint16); \
PATTERN(shortname##_int64, basename##_int64); \
PATTERN(shortname##_uint64, basename##_uint64);

Definition at line 139 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DECLARATION_4_NOSTR

#define C_TEMPLATE_FUNCTION_DECLARATION_4_NOSTR (   shortname,
  basename,
  PATTERN 
)
Value:
PATTERN(shortname##_float, basename##_float, float); \
PATTERN(shortname##_double, basename##_double, double); \
PATTERN(shortname##_ldouble, basename##_ldouble, long double); \
PATTERN(shortname##_char, basename##_char, char); \
PATTERN(shortname##_short, basename##_short, short); \
PATTERN(shortname##_ushort, basename##_ushort, unsigned short); \
PATTERN(shortname##_int, basename##_int, int); \
PATTERN(shortname##_uint, basename##_uint, unsigned); \
PATTERN(shortname##_lint, basename##_lint, long); \
PATTERN(shortname##_ulint, basename##_ulint, unsigned long); \
PATTERN(shortname##_llint, basename##_llint, long long); \
PATTERN(shortname##_ullint, basename##_ullint, unsigned long long); \
PATTERN(shortname##_int32, basename##_int32, int32_t); \
PATTERN(shortname##_uint32, basename##_uint32, uint32_t); \
PATTERN(shortname##_int16, basename##_int16, int16_t); \
PATTERN(shortname##_uint16, basename##_uint16, uint16_t); \
PATTERN(shortname##_int64, basename##_int64, int64_t); \
PATTERN(shortname##_uint64, basename##_uint64, uint64_t);

Definition at line 119 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DECLARATION_NOSTR

#define C_TEMPLATE_FUNCTION_DECLARATION_NOSTR (   funcname,
  PATTERN 
)     C_TEMPLATE_FUNCTION_DECLARATION_3_NOSTR(funcname, funcname, PATTERN)

Definition at line 163 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DEFINITION

#define C_TEMPLATE_FUNCTION_DEFINITION (   funcname,
  PATTERN 
)
Value:
C_TEMPLATE_FUNCTION_DEFINITION_NOSTR(funcname, PATTERN) \
PATTERN(funcname##_str, std::string)
C_TEMPLATE_FUNCTION_DEFINITION_NOSTR
#define C_TEMPLATE_FUNCTION_DEFINITION_NOSTR(funcname, PATTERN)
Definition: c_binding_macros.h:95

Used to expand templates to provide bindings for template-deprived languages (C, Fortran).

Note
There is a similar macro in the ioda python interface.

Definition at line 170 of file c_binding_macros.h.

◆ C_TEMPLATE_FUNCTION_DEFINITION_NOSTR

#define C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (   funcname,
  PATTERN 
)
Value:
PATTERN(funcname##_float, float) \
PATTERN(funcname##_double, double) \
PATTERN(funcname##_ldouble, long double) \
PATTERN(funcname##_char, char) \
PATTERN(funcname##_short, short int) \
PATTERN(funcname##_ushort, unsigned short int) \
PATTERN(funcname##_int, int) \
PATTERN(funcname##_uint, unsigned int) \
PATTERN(funcname##_lint, long int) \
PATTERN(funcname##_ulint, unsigned long int) \
PATTERN(funcname##_llint, long long int) \
PATTERN(funcname##_ullint, unsigned long long int) \
PATTERN(funcname##_int32, int32_t) \
PATTERN(funcname##_uint32, uint32_t) \
PATTERN(funcname##_int16, int16_t) \
PATTERN(funcname##_uint16, uint16_t) \
PATTERN(funcname##_int64, int64_t) \
PATTERN(funcname##_uint64, uint64_t)

Definition at line 95 of file c_binding_macros.h.

◆ C_TRY

#define C_TRY   try {

Goes with C_CATCH_AND_TERMINATE.

Definition at line 31 of file c_binding_macros.h.