rz_event.h File Reference

#include <ht_up.h>
#include <rz_vector.h>

Go to the source code of this file.

Classes
struct	rz_event_t
struct	rz_event_callback_handle_t
struct	rz_event_meta_t
struct	rz_event_class_t
struct	rz_event_class_rename_t
struct	rz_event_class_attr_t
struct	rz_event_class_attr_set_t
struct	rz_event_class_attr_rename_t
struct	rz_event_debug_process_finished_t

Typedefs
typedef struct rz_event_t	RzEvent
typedef struct rz_event_callback_handle_t	RzEventCallbackHandle
typedef void(*	RzEventCallback) (RzEvent *ev, int type, void *user, void *data)
typedef struct rz_event_meta_t	RzEventMeta
typedef struct rz_event_class_t	RzEventClass
typedef struct rz_event_class_rename_t	RzEventClassRename
typedef struct rz_event_class_attr_t	RzEventClassAttr
typedef struct rz_event_class_attr_set_t	RzEventClassAttrSet
typedef struct rz_event_class_attr_rename_t	RzEventClassAttrRename
typedef struct rz_event_debug_process_finished_t	RzEventDebugProcessFinished

Enumerations
enum	RzEventType {   RZ_EVENT_ALL = 0 , RZ_EVENT_META_SET , RZ_EVENT_META_DEL , RZ_EVENT_META_CLEAR ,   RZ_EVENT_CLASS_NEW , RZ_EVENT_CLASS_DEL , RZ_EVENT_CLASS_RENAME , RZ_EVENT_CLASS_ATTR_SET ,   RZ_EVENT_CLASS_ATTR_DEL , RZ_EVENT_CLASS_ATTR_RENAME , RZ_EVENT_DEBUG_PROCESS_FINISHED , RZ_EVENT_IO_WRITE ,   RZ_EVENT_IO_DESC_CLOSE , RZ_EVENT_IO_MAP_DEL , RZ_EVENT_BIN_FILE_DEL , RZ_EVENT_MAX }

Functions
RZ_API RzEvent *	rz_event_new (void *user)
RZ_API void	rz_event_free (RzEvent *ev)
RZ_API RzEventCallbackHandle	rz_event_hook (RzEvent *ev, int type, RzEventCallback cb, void *user)
RZ_API void	rz_event_unhook (RzEvent *ev, RzEventCallbackHandle handle)
RZ_API void	rz_event_send (RzEvent *ev, int type, void *data)

Typedef Documentation

RzEvent

typedef struct rz_event_t RzEvent

RzEventCallback

typedef void(* RzEventCallback) (RzEvent *ev, int type, void *user, void *data)

Definition at line 28 of file rz_event.h.

RzEventCallbackHandle

typedef struct rz_event_callback_handle_t RzEventCallbackHandle

RzEventClass

typedef struct rz_event_class_t RzEventClass

RzEventClassAttr

typedef struct rz_event_class_attr_t RzEventClassAttr

RzEventClassAttrRename

typedef struct rz_event_class_attr_rename_t RzEventClassAttrRename

RzEventClassAttrSet

typedef struct rz_event_class_attr_set_t RzEventClassAttrSet

RzEventClassRename

typedef struct rz_event_class_rename_t RzEventClassRename

RzEventDebugProcessFinished

typedef struct rz_event_debug_process_finished_t RzEventDebugProcessFinished

RzEventMeta

typedef struct rz_event_meta_t RzEventMeta

Enumeration Type Documentation

RzEventType

enum RzEventType

Enumerator
RZ_EVENT_ALL
RZ_EVENT_META_SET
RZ_EVENT_META_DEL
RZ_EVENT_META_CLEAR
RZ_EVENT_CLASS_NEW
RZ_EVENT_CLASS_DEL
RZ_EVENT_CLASS_RENAME
RZ_EVENT_CLASS_ATTR_SET
RZ_EVENT_CLASS_ATTR_DEL
RZ_EVENT_CLASS_ATTR_RENAME
RZ_EVENT_DEBUG_PROCESS_FINISHED
RZ_EVENT_IO_WRITE
RZ_EVENT_IO_DESC_CLOSE
RZ_EVENT_IO_MAP_DEL
RZ_EVENT_BIN_FILE_DEL
RZ_EVENT_MAX

Definition at line 30 of file rz_event.h.

             {
    RZ_EVENT_ALL = 0,
    RZ_EVENT_META_SET, // RzEventMeta
    RZ_EVENT_META_DEL, // RzEventMeta
    RZ_EVENT_META_CLEAR, // RzEventMeta
    RZ_EVENT_CLASS_NEW, // RzEventClass
    RZ_EVENT_CLASS_DEL, // RzEventClass
    RZ_EVENT_CLASS_RENAME, // RzEventClassRename
    RZ_EVENT_CLASS_ATTR_SET, // RzEventClassAttr
    RZ_EVENT_CLASS_ATTR_DEL, // RzEventClassAttrSet
    RZ_EVENT_CLASS_ATTR_RENAME, // RzEventClassAttrRename
    RZ_EVENT_DEBUG_PROCESS_FINISHED, // RzEventDebugProcessFinished
    RZ_EVENT_IO_WRITE, // RzEventIOWrite
    RZ_EVENT_IO_DESC_CLOSE, // RzEventIODescClose
    RZ_EVENT_IO_MAP_DEL, // RzEventIOMapDel
    RZ_EVENT_BIN_FILE_DEL, // RzEventBinFileDel
    RZ_EVENT_MAX,
} RzEventType;

Function Documentation

rz_event_free()

RZ_API void rz_event_free

(

RzEvent *

ev

)

Definition at line 37 of file event.c.

                                       {
    if (!ev) {
        return;
    }
    rz_vector_fini(&ev->pending_unhook);
    ht_up_free(ev->callbacks);
    rz_vector_fini(&ev->all_callbacks);
    free(ev);
}

References rz_event_t::all_callbacks, rz_event_t::callbacks, free(), rz_event_t::pending_unhook, and rz_vector_fini().

Referenced by rz_bin_free(), rz_bin_new(), rz_core_fini(), rz_event_new(), rz_io_fini(), and rz_spaces_fini().

rz_event_hook()

RZ_API RzEventCallbackHandle rz_event_hook	(	RzEvent *	ev,
		int	type,
		RzEventCallback	cb,
		void *	user
	)

Definition at line 58 of file event.c.

                                                                                                  {
    RzEventCallbackHandle handle = { 0 };
    RzEventCallbackHook hook;
 
    rz_return_val_if_fail(ev, handle);
    hook.cb = cb;
    hook.user = user;
    hook.handle = ev->next_handle++;
    if (type == RZ_EVENT_ALL) {
        rz_vector_push(&ev->all_callbacks, &hook);
    } else {
        RzVector *cbs = get_cbs(ev, type);
        if (!cbs) {
            return handle;
        }
        rz_vector_push(cbs, &hook);
    }
    handle.handle = hook.handle;
    handle.type = type;
    return handle;
}

References rz_event_t::all_callbacks, cb, rz_event_callback_hook_t::cb, get_cbs(), handle, rz_event_callback_hook_t::handle, rz_event_t::next_handle, RZ_EVENT_ALL, rz_return_val_if_fail, rz_vector_push(), type, and rz_event_callback_hook_t::user.

Referenced by new_spaces(), rz_analysis_new(), and rz_core_init().

rz_event_new()

RZ_API RzEvent* rz_event_new

(

void *

user

)

Definition at line 17 of file event.c.

                                         {
    RzEvent *ev = RZ_NEW0(RzEvent);
    if (!ev) {
        return NULL;
    }
 
    ev->user = user;
    ev->next_handle = 0;
    ev->callbacks = ht_up_new(NULL, ht_callback_free, NULL);
    if (!ev->callbacks) {
        goto err;
    }
    rz_vector_init(&ev->all_callbacks, sizeof(RzEventCallbackHook), NULL, NULL);
    rz_vector_init(&ev->pending_unhook, sizeof(RzEventCallbackHandle), NULL, NULL);
    return ev;
err:
    rz_event_free(ev);
    return NULL;
}

References rz_event_t::all_callbacks, rz_event_t::callbacks, err, ht_callback_free(), rz_event_t::next_handle, NULL, rz_event_t::pending_unhook, rz_event_free(), RZ_NEW0, rz_vector_init(), and rz_event_t::user.

Referenced by rz_bin_new(), rz_core_init(), rz_io_init(), and rz_spaces_init().

rz_event_send()

RZ_API void rz_event_send	(	RzEvent *	ev,
		int	type,
		void *	data
	)

Definition at line 115 of file event.c.

                                                             {
    RzEventCallbackHook *hook;
    rz_return_if_fail(ev && !ev->incall);
 
    // send to both the per-type callbacks and to the all_callbacks
    ev->incall = true;
    rz_vector_foreach(&ev->all_callbacks, hook) {
        hook->cb(ev, type, hook->user, data);
    }
    ev->incall = false;
 
    RzVector *cbs = ht_up_find(ev->callbacks, (ut64)type, NULL);
    if (cbs) {
        ev->incall = true;
        rz_vector_foreach(cbs, hook) {
            hook->cb(ev, type, hook->user, data);
        }
        ev->incall = false;
    }
 
    RzEventCallbackHandle *unhook_handle;
    rz_vector_foreach(&ev->pending_unhook, unhook_handle) {
        rz_event_unhook(ev, *unhook_handle);
    }
    rz_vector_clear(&ev->pending_unhook);
}

References rz_event_t::all_callbacks, rz_event_t::callbacks, rz_event_callback_hook_t::cb, rz_event_t::incall, NULL, rz_event_t::pending_unhook, rz_event_unhook(), rz_return_if_fail, rz_vector_clear(), rz_vector_foreach, type, rz_event_callback_hook_t::user, and ut64().

Referenced by map_del(), rz_analysis_class_create(), rz_analysis_class_delete(), rz_analysis_class_delete_attr_raw(), rz_analysis_class_rename(), rz_analysis_class_rename_attr_raw(), rz_analysis_class_set_attr_raw(), rz_bin_file_delete(), rz_bin_file_delete_all(), rz_debug_wait(), rz_io_cache_write(), rz_io_desc_cache_write(), rz_io_desc_close(), rz_io_map_fini(), rz_io_plugin_write(), rz_spaces_count(), rz_spaces_rename(), and spaces_unset_single().

rz_event_unhook()

RZ_API void rz_event_unhook	(	RzEvent *	ev,
		RzEventCallbackHandle	handle
	)

Definition at line 95 of file event.c.

                                                                       {
    rz_return_if_fail(ev);
    if (ev->incall) {
        // when inside a call (meaning rz_event_send currently iterates over the callback vectors),
        // defer the unhook to after the rz_event_send is done.
        rz_vector_push(&ev->pending_unhook, &handle);
        return;
    }
    if (handle.type == RZ_EVENT_ALL) {
        // try to delete it both from each list of callbacks and from
        // the "all_callbacks" vector
        ht_up_foreach(ev->callbacks, del_hook, &handle.handle);
        del_hook(&handle.handle, 0, &ev->all_callbacks);
    } else {
        RzVector *cbs = ht_up_find(ev->callbacks, (ut64)handle.type, NULL);
        rz_return_if_fail(cbs);
        del_hook(&handle.handle, 0, cbs);
    }
}

References rz_event_t::all_callbacks, rz_event_t::callbacks, del_hook(), handle, rz_event_t::incall, NULL, rz_event_t::pending_unhook, RZ_EVENT_ALL, rz_return_if_fail, rz_vector_push(), and ut64().

Referenced by rz_event_send().