amxd_object_action.h File Reference

#include <stdint.h>
#include <amxd/amxd_types.h>

Go to the source code of this file.

Functions
amxd_status_t	amxd_object_add_action_cb (amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn, void *priv)
amxd_status_t	amxd_object_remove_action_cb (amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn)
void	amxd_object_enable_action_cb (const amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn, bool enable)
bool	amxd_object_has_action_cb (amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn)
bool	amxd_object_has_action (amxd_object_t *const object, const amxd_action_t reason)
void *	amxd_object_get_action_cb_data (amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn)
void	amxd_object_set_action_cb_data (amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn, void *data)
bool	amxd_action_can_add_function (uint32_t func_attrs, const amxd_object_type_t type, amxd_dm_access_t access, bool template_info)
bool	amxd_action_can_add_param (uint32_t param_attrs, const amxd_object_type_t type, amxd_dm_access_t access, bool template_info)
bool	amxd_action_can_access_object (uint32_t object_attrs, amxd_dm_access_t access)
bool	amxd_action_verify_access (amxd_object_t *object, amxd_dm_access_t access)

Function Documentation

amxd_action_can_access_object()

bool amxd_action_can_access_object	(	uint32_t	object_attrs,
		amxd_dm_access_t	access
	)

Definition at line 275 of file amxd_object_action.c.

                                                            {
    bool retval = false;
    switch(access) {
    case amxd_dm_access_public:
        when_true(IS_BIT_SET(object_attrs, amxd_oattr_private) ||
                  IS_BIT_SET(object_attrs, amxd_oattr_protected), exit);
        break;
    case amxd_dm_access_protected:
        when_true(IS_BIT_SET(object_attrs, amxd_oattr_private), exit);
        break;
    case amxd_dm_access_private:
        break;
    }
 
    retval = true;
 
exit:
    return retval;
}

amxd_action_can_add_function()

bool amxd_action_can_add_function	(	uint32_t	func_attrs,
		const amxd_object_type_t	type,
		amxd_dm_access_t	access,
		bool	template_info
	)

Definition at line 219 of file amxd_object_action.c.

                                                      {
    bool retval = false;
    when_true((type == amxd_object_instance) &&
              !IS_BIT_SET(func_attrs, amxd_fattr_instance), exit);
    when_true((type == amxd_object_template) &&
              !IS_BIT_SET(func_attrs, amxd_fattr_template) &&
              !template_info, exit);
    switch(access) {
    case amxd_dm_access_public:
        when_true(IS_BIT_SET(func_attrs, amxd_fattr_private) ||
                  IS_BIT_SET(func_attrs, amxd_fattr_protected), exit);
        break;
    case amxd_dm_access_protected:
        when_true(IS_BIT_SET(func_attrs, amxd_fattr_private), exit);
        break;
    case amxd_dm_access_private:
        break;
    }
 
    retval = true;
 
exit:
    return retval;
}

amxd_action_can_add_param()

bool amxd_action_can_add_param	(	uint32_t	param_attrs,
		const amxd_object_type_t	type,
		amxd_dm_access_t	access,
		bool	template_info
	)

Definition at line 247 of file amxd_object_action.c.

                                                   {
    bool retval = false;
    when_true((type == amxd_object_instance) &&
              !IS_BIT_SET(param_attrs, amxd_pattr_instance), exit);
    when_true((type == amxd_object_template) &&
              !IS_BIT_SET(param_attrs, amxd_pattr_template) &&
              !template_info, exit);
    switch(access) {
    case amxd_dm_access_public:
        when_true(IS_BIT_SET(param_attrs, amxd_pattr_private) ||
                  IS_BIT_SET(param_attrs, amxd_pattr_protected), exit);
        break;
    case amxd_dm_access_protected:
        when_true(IS_BIT_SET(param_attrs, amxd_pattr_private), exit);
        break;
    case amxd_dm_access_private:
        break;
    }
 
    retval = true;
 
exit:
    return retval;
}

amxd_action_verify_access()

bool amxd_action_verify_access	(	amxd_object_t *	object,
		amxd_dm_access_t	access
	)

Definition at line 296 of file amxd_object_action.c.

                                                        {
    uint32_t obj_attrs = amxd_object_get_attrs(object);
    bool retval = amxd_action_can_access_object(obj_attrs, access);
 
    if(retval) {
        amxd_object_t* parent = amxd_object_get_parent(object);
        if(parent != NULL) {
            retval = amxd_action_verify_access(parent, access);
        }
    }
 
    return retval;
}

amxd_object_add_action_cb()

amxd_status_t amxd_object_add_action_cb	(	amxd_object_t *const	object,
		const amxd_action_t	reason,
		amxd_action_fn_t	fn,
		void *	priv
	)

Definition at line 73 of file amxd_object_action.c.

                                                    {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_dm_cb_t* cb = NULL;
    when_null(object, exit);
    when_null(fn, exit);
 
    cb = amxd_get_action(&object->cb_fns, reason, fn);
    if((cb != NULL) && (cb->priv == priv)) {
        goto exit;
    }
 
    cb = (amxd_dm_cb_t*) calloc(1, sizeof(amxd_dm_cb_t));
    when_null(cb, exit);
 
    cb->fn = fn;
    cb->reason = reason;
    cb->priv = priv;
    cb->enable = true;
 
    amxc_llist_append(&object->cb_fns, &cb->it);
    status = amxd_status_ok;
 
exit:
    return status;
}

amxd_object_enable_action_cb()

void amxd_object_enable_action_cb	(	const amxd_object_t *const	object,
		const amxd_action_t	reason,
		amxd_action_fn_t	fn,
		bool	enable
	)

Definition at line 122 of file amxd_object_action.c.

                                               {
    amxd_dm_cb_t* cb = NULL;
    when_null(object, exit);
    when_null(fn, exit);
 
    cb = amxd_get_action(&object->cb_fns, reason, fn);
    when_null(cb, exit);
 
    cb->enable = enable;
 
exit:
    return;
}

amxd_object_get_action_cb_data()

void* amxd_object_get_action_cb_data	(	amxd_object_t *const	object,
		const amxd_action_t	reason,
		amxd_action_fn_t	fn
	)

Definition at line 185 of file amxd_object_action.c.

                                                          {
    amxd_dm_cb_t* cb = NULL;
    when_null(object, exit);
    when_null(fn, exit);
 
    cb = amxd_get_action(&object->cb_fns, reason, fn);
 
exit:
    if(cb != NULL) {
        return cb->priv;
    } else {
        return NULL;
    }
}

amxd_object_has_action()

bool amxd_object_has_action	(	amxd_object_t *const	object,
		const amxd_action_t	reason
	)

Definition at line 156 of file amxd_object_action.c.

                                                                                     {
    bool has_cb = false;
    amxd_dm_cb_t* cb = NULL;
    amxd_object_t* super = object;
    when_null(object, exit);
 
    while(super != NULL) {
        cb = amxd_get_action(&object->cb_fns, reason, NULL);
        if(cb != NULL) {
            has_cb = true;
            break;
        }
 
        if(amxd_object_get_type(super) == amxd_object_instance) {
            super = amxd_object_get_parent(super);
        } else {
            super = (super->derived_from.llist == NULL) ?
                NULL :
                amxc_container_of(super->derived_from.llist,
                                  amxd_object_t,
                                  derived_objects);
        }
 
    }
 
exit:
    return has_cb;
}

amxd_object_has_action_cb()

bool amxd_object_has_action_cb	(	amxd_object_t *const	object,
		const amxd_action_t	reason,
		amxd_action_fn_t	fn
	)

Definition at line 139 of file amxd_object_action.c.

                                                    {
    bool has_cb = false;
    amxd_dm_cb_t* cb = NULL;
    when_null(object, exit);
    when_null(fn, exit);
 
    cb = amxd_get_action(&object->cb_fns, reason, fn);
    when_null(cb, exit);
 
    has_cb = true;
 
exit:
    return has_cb;
}

amxd_object_remove_action_cb()

amxd_status_t amxd_object_remove_action_cb	(	amxd_object_t *const	object,
		const amxd_action_t	reason,
		amxd_action_fn_t	fn
	)

Definition at line 102 of file amxd_object_action.c.

                                                                {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_dm_cb_t* cb = NULL;
    when_null(object, exit);
    when_null(fn, exit);
 
    cb = amxd_get_action(&object->cb_fns, reason, fn);
    when_null(cb, exit);
 
    amxc_llist_it_take(&cb->it);
    free(cb);
 
    status = amxd_status_ok;
 
exit:
    return status;
}

amxd_object_set_action_cb_data()

void amxd_object_set_action_cb_data	(	amxd_object_t *const	object,
		const amxd_action_t	reason,
		amxd_action_fn_t	fn,
		void *	data
	)

Definition at line 202 of file amxd_object_action.c.

                                                {
    amxd_dm_cb_t* cb = NULL;
    when_null(object, exit);
    when_null(fn, exit);
 
    cb = amxd_get_action(&object->cb_fns, reason, fn);
    if(cb != NULL) {
        cb->priv = data;
    }
 
exit:
    return;
}