states.h

Go to the documentation of this file.

#ifndef JABBERWERX_UTIL_STATES_H
#define JABBERWERX_UTIL_STATES_H


#include "../eventing.h"
#include "mem.h"
#include "workq.h"


#define JW_STATES_EVENT "stateChanged"

#define JW_STATES_NAME(num) #num


typedef uint8_t jw_state_val;

typedef struct _jw_states jw_states;

typedef struct _jw_states_event_data jw_states_event_data;


#ifdef __cplusplus
extern "C"
{
#endif

JABBERWERX_API bool jw_states_create(const char **names,
                                     jw_state_val initial,
                                     jw_workq    *workq,
                                     jw_states  **states,
                                     jw_err      *err);

JABBERWERX_API void jw_states_destroy(jw_states *states);

JABBERWERX_API jw_state_val jw_states_get_current(jw_states *states);

JABBERWERX_API const char * jw_states_get_name_for(jw_states   *states,
                                                   jw_state_val state_val);

JABBERWERX_API bool jw_states_register_for(jw_states               *states,
                                           jw_state_val             current,
                                           jw_event                *evt,
                                           jw_event_notify_callback cb,
                                           void                    *arg,
                                           jw_err                  *err);

JABBERWERX_API bool jw_states_change(jw_states        *states,
                                     jw_state_val      next,
                                     void             *extra,
                                     jw_data_free_func extra_cleaner,
                                     jw_err           *err);

JABBERWERX_API jw_event *jw_states_event(jw_states *states, const char *name);

JABBERWERX_API jw_state_val jw_states_event_data_get_prev(
        jw_states_event_data *event_data);

JABBERWERX_API jw_state_val jw_states_event_data_get_next(
        jw_states_event_data *event_data);

JABBERWERX_API void * jw_states_event_data_get_extra(
        jw_states_event_data *event_data);

#ifdef __cplusplus
}
#endif

#endif  /* JABBERWERX_UTIL_STATES_H */