props.h

Go to the documentation of this file.

 
#pragma once
 
#include <cache/xroad_objects_types.h>
#include <common/xroad_common_types.h>
#include <node/xroad_node_types.h>
#include <common/xroad_xml.h>
#include <common/xroad_time.h>
#include <cache/xroad_objects.h>
#include <json.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct props_s props_t;
typedef struct props_prop_s props_prop_t;
typedef struct props_row_s props_row_t;
typedef struct props_cursor_s props_cursor_t;
 
typedef enum
{
   props_event_prop_changed = 1,
   props_event_row_added    = 2,
   props_event_row_deleted  = 3
} props_event_t;
 
typedef struct
{
   void* ctx;
   void (*on_props_event)(props_t*, props_event_t, void*, void*);
} props_callback_t;
 
typedef struct
{
   xroad_node_id_t node_id;
   xroad_errno_t* error;
   props_callback_t cback;
} props_create_args_t;
 
#define props_create(...)                                                              \
({                                                                                     \
   props_create_args_t args = {.node_id = 0, .error = NULL, .cback = {}, __VA_ARGS__}; \
   props_create_ex(args.node_id, args.error, args.cback);                              \
})
 
props_t* props_create_ex(xroad_node_id_t node_id, xroad_errno_t* error, props_callback_t cback);
 
void props_destroy(props_t* props);
 
#define __props_dtor__ __dtor__(props_destructor)
void props_destructor(props_t** props);
 
xroad_props_t* props_get_xprops(props_t* props);
 
props_prop_t* props_get_prop(void* obj, xroad_str_t name);
 
xroad_str_t props_get_error(props_t* props);
 
void* props_query(props_t* props, xroad_str_t query);
 
props_cursor_t* props_create_cursor(void* obj);
 
void props_destroy_cursor(props_cursor_t* cur);
 
#define __props_cursor_dtor__ __dtor__(props_cursor_destructor)
void props_cursor_destructor(props_cursor_t** cur);
 
void* props_cursor_get_first(props_cursor_t* cur);
 
void* props_cursor_get_next(props_cursor_t* cur);
 
xroad_prop_type_t props_get_type(props_prop_t* prop);
 
xroad_str_t props_get_name(void* obj);
 
xroad_object_id_t props_get_id(void* obj);
 
xroad_str_t props_to_str(props_prop_t* prop);
 
int64_t props_get_int64(props_prop_t* prop);
 
xroad_errno_t props_set_int64(props_prop_t* prop, int64_t value);
 
double props_get_double(props_prop_t* prop);
 
xroad_errno_t props_set_double(props_prop_t* prop, double value);
 
xroad_str_t props_get_str(props_prop_t* prop);
 
xroad_errno_t props_set_str(props_prop_t* prop, xroad_str_t value);
 
xroad_time_t props_get_time(props_prop_t* prop);
 
xroad_errno_t props_set_time(props_prop_t* prop, xroad_time_t value);
 
bool props_get_bool(props_prop_t* prop);
 
xroad_errno_t props_set_bool(props_prop_t* prop, bool value);
 
xroad_errno_t props_add_link(props_prop_t* prop, xroad_prop_t* link, bool notify);
 
xroad_errno_t props_del_link(props_prop_t* prop);
 
bool props_has_link(props_prop_t* prop);
 
xroad_errno_t props_reset(props_prop_t* prop);
 
bool props_is_set(props_prop_t* prop);
 
bool props_is_row(void* obj);
 
xroad_errno_t props_notify(props_prop_t* prop);
 
xroad_errno_t props_calc_hash(props_prop_t* prop);
 
xroad_prop_t* props_get_xprop(void* prop);
 
xroad_prop_t* props_get_link(props_prop_t* prop);
 
int32_t props_get_row_count(props_prop_t* prop);
 
props_row_t* props_add_row(props_prop_t* prop);
 
props_row_t* props_get_row(props_prop_t* prop, xroad_object_id_t row_id);
 
xroad_errno_t props_row_delete(props_row_t* row);
 
void* props_get_parent(void* obj);
 
xroad_prop_row_t* props_row_get_xrow(props_row_t* row);
 
xroad_props_t* props_clone(props_t* props, xroad_node_id_t node_id);
 
json_object* props_get_descr(void* obj);
 
#ifdef __cplusplus
}
#endif
 
//**************************************************************************************
//  helper for set/get property by one line
//*************************************************************************************
 
#ifdef __cplusplus
 
template<typename value_type_t>
xroad_errno_t props_get(void* obj, xroad_str_t name, value_type_t* value, props_prop_t** prop = NULL);
 
xroad_errno_t props_set(void* obj, xroad_str_t name, int64_t value);
 
xroad_errno_t props_get(void* obj, xroad_str_t name, double* value, props_prop_t** prop = NULL);
 
xroad_errno_t props_set(void* obj, xroad_str_t name, double value);
 
xroad_errno_t props_get(void* obj, xroad_str_t name, xroad_str_t* value, props_prop_t** prop = NULL);
 
xroad_errno_t props_set(void* obj, xroad_str_t name, xroad_str_t value);
 
xroad_errno_t props_get(void* obj, xroad_str_t name, xroad_time_t* value, props_prop_t** prop = NULL);
 
xroad_errno_t props_set(void* obj, xroad_str_t name, xroad_time_t value);
 
xroad_errno_t props_get(void* obj, xroad_str_t name, bool* value, props_prop_t** prop = NULL);
 
xroad_errno_t props_set(void* obj, xroad_str_t name, bool value);
 
#else
 
xroad_errno_t props_get_int8_by_name(void* obj, xroad_str_t name, int8_t* value, ...);
 
xroad_errno_t props_get_int16_by_name(void* obj, xroad_str_t name, int16_t* value, ...);
 
xroad_errno_t props_get_int32_by_name(void* obj, xroad_str_t name, int32_t* value, ...);
 
xroad_errno_t props_get_int64_by_name(void* obj, xroad_str_t name, int64_t* value, ...);
 
xroad_errno_t props_set_int64_by_name(void* obj, xroad_str_t name, int64_t value);
 
xroad_errno_t props_get_bool_by_name(void* obj, xroad_str_t name, bool* value, ...);
 
xroad_errno_t props_set_bool_by_name(void* obj, xroad_str_t name, bool value);
xroad_errno_t props_get_double_by_name(void* obj, xroad_str_t name, double* value, ...);
 
xroad_errno_t props_set_double_by_name(void* obj, xroad_str_t name, double value);
 
xroad_errno_t props_get_str_by_name(void* obj, xroad_str_t name, xroad_str_t* value, ...);
 
xroad_errno_t props_set_str_by_name(void* obj, xroad_str_t name, xroad_str_t value);
 
xroad_errno_t props_get_time_by_name(void* obj, xroad_str_t name, xroad_time_t* value, ...);
 
xroad_errno_t props_set_time_by_name(void* obj, xroad_str_t name, xroad_time_t value);
 
#define props_get(props, name, value, ...) _Generic((value),   \
         bool*:         props_get_bool_by_name,                \
         int8_t*:       props_get_int8_by_name,                \
         int16_t*:      props_get_int16_by_name,               \
         int32_t*:      props_get_int32_by_name,               \
         int64_t*:      props_get_int64_by_name,               \
         double*:       props_get_double_by_name,              \
         xroad_str_t*:  props_get_str_by_name,                 \
         xroad_time_t*: props_get_time_by_name                 \
      )(props, name, value, ## __VA_ARGS__, NULL)
 
#define props_set(props, name, value) _Generic((value),  \
         int64_t:      props_set_int64_by_name,          \
         double:       props_set_double_by_name,         \
         xroad_str_t:  props_set_str_by_name,            \
         xroad_time_t: props_set_time_by_name,           \
         default:      props_set_int64_by_name           \
      )(props, name, value)
 
#endif // __cplusplus