efl/legacy/eobj/lib/eo.c

1549 lines
37 KiB
C
Raw Normal View History

#include <Eina.h>
#include "Eo.h"
#include "eo_private.h"
#include "config.h"
typedef int Eo_Class_Id;
/* Used inside the class_get functions of classes, see #EO_DEFINE_CLASS */
EAPI Eina_Lock _eo_class_creation_lock;
int _eo_log_dom = -1;
static Eo_Class **_eo_classes;
static Eo_Class_Id _eo_classes_last_id;
static Eina_Bool _eo_init_count = 0;
static void _eo_callback_remove_all(Eo *obj);
static void _eo_constructor(Eo *obj, const Eo_Class *klass);
static void _eo_destructor(Eo *obj, const Eo_Class *klass);
static void eo_constructor_error_unset(Eo *obj);
typedef struct _Eo_Callback_Description Eo_Callback_Description;
#define EO_EINA_MAGIC 0xa186bc32 /* Nothing magical about this number. */
#define EO_EINA_MAGIC_STR "Eo"
#define EO_CLASS_EINA_MAGIC 0xa186bb32 /* Nothing magical about this number. */
#define EO_CLASS_EINA_MAGIC_STR "Eo Class"
#define EO_MAGIC_RETURN_VAL(d, magic, ret) \
do { \
if (!EINA_MAGIC_CHECK(d, magic)) \
{ \
EINA_MAGIC_FAIL(d, magic); \
return ret; \
} \
} while (0)
#define EO_MAGIC_RETURN(d, magic) \
do { \
if (!EINA_MAGIC_CHECK(d, magic)) \
{ \
EINA_MAGIC_FAIL(d, magic); \
return; \
} \
} while (0)
struct _Eo {
EINA_MAGIC
Eo *parent;
const Eo_Class *klass;
int refcount;
#ifndef NDEBUG
Eina_Inlist *xrefs;
#endif
Eina_List *composite_objects;
Eina_Inlist *callbacks;
int walking_list;
Eina_Inlist *kls_itr;
Eina_Bool delete:1;
Eina_Bool construct_error:1;
};
/* Start of Dich */
/* Dich search, split to 0xff 0xff 0xffff */
#define DICH_CHAIN1_MASK (0xff)
#define DICH_CHAIN2_MASK (0xff)
#define DICH_CHAIN_LAST_MASK (0xffff)
#define DICH_CHAIN1_SIZE (DICH_CHAIN1_MASK + 1)
#define DICH_CHAIN2_SIZE (DICH_CHAIN2_MASK + 1)
#define DICH_CHAIN_LAST_SIZE (DICH_CHAIN_LAST_MASK + 1)
#define DICH_CHAIN1(x) (((x) >> 24) & DICH_CHAIN1_MASK)
#define DICH_CHAIN2(x) (((x) >> 16) & DICH_CHAIN2_MASK)
#define DICH_CHAIN_LAST(x) ((x) & DICH_CHAIN_LAST_MASK)
#define OP_CLASS_OFFSET 16
#define OP_CLASS_OFFSET_GET(x) (((x) >> OP_CLASS_OFFSET) & 0xffff)
#define OP_CLASS_GET(op) ({ \
Eo_Class_Id tmp = OP_CLASS_OFFSET_GET(op); \
(Eo_Class *) ((tmp <= _eo_classes_last_id) && (tmp > 0)) ? \
(_eo_classes[tmp - 1]) : NULL; \
})
#define OP_SUB_ID_GET(op) ((op) & 0xffff)
#define EO_ALIGN_SIZE(size) \
((size) + (sizeof(void *) - ((size) % sizeof(void *))))
/* Structure of Eo_Op is:
* 16bit: class
* 16bit: op.
*/
typedef struct _Dich_Chain1 Dich_Chain1;
typedef struct
{
eo_op_func_type func;
} op_type_funcs;
typedef struct
{
op_type_funcs *funcs;
} Dich_Chain2;
struct _Dich_Chain1
{
Dich_Chain2 *chain;
};
typedef struct
{
EINA_INLIST;
const Eo_Class *klass;
} Eo_Extension_Node;
typedef struct
{
const Eo_Class *klass;
size_t offset;
} Eo_Extension_Data_Offset;
struct _Eo_Class
{
EINA_MAGIC
Eo_Class_Id class_id;
const Eo_Class *parent;
const Eo_Class_Description *desc;
Dich_Chain1 chain[DICH_CHAIN1_SIZE];
Eina_Inlist *extensions;
Eo_Extension_Data_Offset *extn_data_off;
size_t extn_data_size;
const Eo_Class **mro;
size_t data_offset; /* < Offset of the data within object data. */
Eina_Bool constructed : 1;
};
static inline eo_op_func_type
dich_func_get(const Eo_Class *klass, Eo_Op op)
{
const Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
if (!chain1) return NULL;
if (!chain1->chain) return NULL;
Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
if (!chain2) return NULL;
if (!chain2->funcs) return NULL;
/* num_ops is calculated from the class. */
const Eo_Class *op_klass = OP_CLASS_GET(op);
if (!op_klass || (DICH_CHAIN_LAST(op) >= op_klass->desc->ops.count))
return NULL;
return chain2->funcs[DICH_CHAIN_LAST(op)].func;
}
static inline void
dich_func_set(Eo_Class *klass, Eo_Op op, eo_op_func_type func)
{
const Eo_Class *op_klass = OP_CLASS_GET(op);
size_t num_ops;
/* Verify op is valid. */
if (op_klass)
{
/* num_ops is calculated from the class. */
num_ops = op_klass->desc->ops.count;
if (DICH_CHAIN_LAST(op) >= num_ops)
{
ERR("OP %x is too big for the domain '%s', expected value < %x.",
op, op_klass->desc->name, op_klass->desc->ops.count);
return;
}
}
else
{
ERR("OP %x is from an illegal class.", op);
return;
}
Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
if (!chain1->chain)
{
chain1->chain = calloc(DICH_CHAIN2_SIZE, sizeof(*(chain1->chain)));
}
Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
if (!chain2->funcs)
{
chain2->funcs = calloc(num_ops, sizeof(*(chain2->funcs)));
}
chain2->funcs[DICH_CHAIN_LAST(op)].func = func;
}
static inline void
dich_func_clean_all(Eo_Class *klass)
{
int i;
Dich_Chain1 *chain1 = klass->chain;
for (i = 0 ; i < DICH_CHAIN1_SIZE ; i++, chain1++)
{
int j;
Dich_Chain2 *chain2 = chain1->chain;
if (!chain2)
continue;
for (j = 0 ; j < DICH_CHAIN2_SIZE ; j++, chain2++)
{
free(chain2->funcs);
}
free(chain1->chain);
chain1->chain = NULL;
}
}
/* END OF DICH */
static const Eo_Op_Description noop_desc =
EO_OP_DESCRIPTION(EO_NOOP, "", "No operation.");
static const Eo_Op_Description *
_eo_op_id_desc_get(Eo_Op op)
{
const Eo_Class *klass = OP_CLASS_GET(op);
Eo_Op sub_id = OP_SUB_ID_GET(op);
if (op == EO_NOOP)
return &noop_desc;
if (klass && (sub_id < klass->desc->ops.count))
return klass->desc->ops.descs + sub_id;
return NULL;
}
static const char *
_eo_op_id_name_get(Eo_Op op)
{
const Eo_Op_Description *desc = _eo_op_id_desc_get(op);
return (desc) ? desc->name : NULL;
}
typedef struct
{
EINA_INLIST;
Eo_Op op;
const Eo_Class **kls_itr;
} Eo_Kls_Itr_Node;
static inline Eina_Bool
_eo_kls_itr_init(Eo *obj, Eo_Op op)
{
if (obj->kls_itr)
{
Eo_Kls_Itr_Node *node =
EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eo_Kls_Itr_Node);
if (node->op == op)
{
return EINA_FALSE;
}
}
{
Eo_Kls_Itr_Node *node = calloc(1, sizeof(*node));
node->op = op;
node->kls_itr = obj->klass->mro;
obj->kls_itr = eina_inlist_prepend(obj->kls_itr,
EINA_INLIST_GET(node));
return EINA_TRUE;
}
}
static inline void
_eo_kls_itr_end(Eo *obj, Eo_Op op)
{
Eo_Kls_Itr_Node *node =
EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eo_Kls_Itr_Node);
if (node->op != op)
return;
obj->kls_itr = eina_inlist_remove(obj->kls_itr, obj->kls_itr);
free(node);
}
static inline const Eo_Class *
_eo_kls_itr_get(Eo *obj)
{
Eo_Kls_Itr_Node *node =
EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eo_Kls_Itr_Node);
return (node) ? *(node->kls_itr) : NULL;
}
static inline const Eo_Class *
_eo_kls_itr_next(Eo *obj, Eo_Op op)
{
Eo_Kls_Itr_Node *node =
EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eo_Kls_Itr_Node);
if (!node || (node->op != op))
{
Eo_Op node_op = (node) ? node->op : EO_NOOP;
ERR("Called with op %d ('%s') while expecting: %d ('%s'). This probaly means you called eo_*_super functions from a wrong place.",
op, _eo_op_id_name_get(op),
node_op, _eo_op_id_name_get(node_op));
return NULL;
}
const Eo_Class **kls_itr = node->kls_itr;
if (*kls_itr)
{
kls_itr++;
node->kls_itr = kls_itr;
return *kls_itr;
}
else
{
return NULL;
}
}
static inline Eina_Bool
_eo_kls_itr_reached_end(const Eo *obj)
{
Eo_Kls_Itr_Node *node =
EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eo_Kls_Itr_Node);
const Eo_Class **kls_itr = node->kls_itr;
return !(*kls_itr && *(kls_itr + 1));
}
static Eina_Bool
_eo_op_internal(Eo *obj, Eina_Bool constant, Eo_Op op, va_list *p_list)
{
const Eo_Class *klass;
Eina_Bool ret = EINA_FALSE;
Eina_Bool _itr_init;
const Eo_Op_Description *op_desc = _eo_op_id_desc_get(op);
if (op_desc &&
((constant == EINA_TRUE) && (op_desc->constant == EINA_FALSE)))
{
ERR("Tried calling non-const or non-existant op '%s' (%d) from a const (query) function.", (op_desc) ? op_desc->name : NULL, op);
return EINA_FALSE;
}
_itr_init = _eo_kls_itr_init(obj, op);
klass = _eo_kls_itr_get(obj);
while (klass)
{
eo_op_func_type func = dich_func_get(klass, op);
if (func)
{
func(obj, eo_data_get(obj, klass), p_list);
ret = EINA_TRUE;
goto end;
}
klass = _eo_kls_itr_next(obj, op);
}
/* Try composite objects */
{
Eina_List *itr;
Eo *emb_obj;
EINA_LIST_FOREACH(obj->composite_objects, itr, emb_obj)
{
if (_eo_op_internal(emb_obj, constant, op, p_list))
{
ret = EINA_TRUE;
goto end;
}
}
}
end:
if (_itr_init) _eo_kls_itr_end(obj, op);
return ret;
}
EAPI Eina_Bool
eo_do_internal(Eo *obj, Eina_Bool constant, ...)
{
Eina_Bool ret = EINA_TRUE;
Eo_Op op = EO_NOOP;
va_list p_list;
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
eo_ref(obj);
va_start(p_list, constant);
op = va_arg(p_list, Eo_Op);
while (op)
{
if (!_eo_op_internal(obj, constant, op, &p_list))
{
const Eo_Class *op_klass = OP_CLASS_GET(op);
const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL;
ERR("Can't find func for op %x ('%s' of domain '%s') for class '%s'. Aborting.",
op, _eo_op_id_name_get(op), _dom_name,
obj->klass->desc->name);
ret = EINA_FALSE;
break;
}
op = va_arg(p_list, Eo_Op);
}
va_end(p_list);
eo_unref(obj);
return ret;
}
EAPI Eina_Bool
eo_do_super_internal(Eo *obj, Eina_Bool constant, Eo_Op op, ...)
{
const Eo_Class *obj_klass;
Eina_Bool ret = EINA_TRUE;
va_list p_list;
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
/* Advance the kls itr. */
obj_klass = _eo_kls_itr_next(obj, op);
if (!obj_klass)
{
return EINA_FALSE;
}
va_start(p_list, op);
if (!_eo_op_internal(obj, constant, op, &p_list))
{
const Eo_Class *op_klass = OP_CLASS_GET(op);
const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL;
ERR("Can't find func for op %x ('%s' of domain '%s') for class '%s'. Aborting.",
op, _eo_op_id_name_get(op), _dom_name,
(obj_klass) ? obj_klass->desc->name : NULL);
ret = EINA_FALSE;
}
va_end(p_list);
return ret;
}
EAPI const Eo_Class *
eo_class_get(const Eo *obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
return obj->klass;
}
EAPI const char *
eo_class_name_get(const Eo_Class *klass)
{
EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, NULL);
return klass->desc->name;
}
static void
_eo_class_base_op_init(Eo_Class *klass)
{
const Eo_Class_Description *desc = klass->desc;
if (!desc || !desc->ops.base_op_id)
return;
/* FIXME: Depends on values defined above! */
*(desc->ops.base_op_id) = klass->class_id << OP_CLASS_OFFSET;
}
static Eina_Bool
_eo_class_mro_has(const Eo_Class *klass, const Eo_Class *find)
{
const Eo_Class **itr;
for (itr = klass->mro ; *itr ; itr++)
{
if (*itr == find)
{
return EINA_TRUE;
}
}
return EINA_FALSE;
}
static Eina_List *
_eo_class_mro_add(Eina_List *mro, const Eo_Class *klass)
{
Eina_List *extn_pos = NULL;
Eina_Bool check_consistency = !mro;
if (!klass)
return mro;
mro = eina_list_append(mro, klass);
/* Recursively add extenions. */
{
Eo_Extension_Node *extn;
EINA_INLIST_FOREACH(klass->extensions, extn)
{
mro = _eo_class_mro_add(mro, extn->klass);
/* Not possible: if (!mro) return NULL; */
if (check_consistency)
{
extn_pos = eina_list_append(extn_pos, eina_list_last(mro));
}
}
}
/* Check if we can create a consistent mro. We only do it for the class
* we are working on (i.e no parents). */
if (check_consistency)
{
Eo_Extension_Node *extn;
Eina_List *itr = extn_pos;
EINA_INLIST_FOREACH(klass->extensions, extn)
{
/* Get the first one after the extension. */
Eina_List *extn_list = eina_list_next(eina_list_data_get(itr));
/* If we found the extension again. */
if (eina_list_data_find_list(extn_list, extn->klass))
{
eina_list_free(mro);
ERR("Cannot create a consistent method resolution order for class '%s' because of '%s'.", klass->desc->name, extn->klass->desc->name);
return NULL;
}
itr = eina_list_next(itr);
}
}
mro = _eo_class_mro_add(mro, klass->parent);
return mro;
}
static Eina_Bool
_eo_class_mro_init(Eo_Class *klass)
{
Eina_List *mro = NULL;
DBG("Started creating MRO for class '%s'", klass->desc->name);
mro = _eo_class_mro_add(mro, klass);
if (!mro)
return EINA_FALSE;
/* Remove duplicates and make them the right order. */
{
Eina_List *itr1, *itr2, *itr2n;
itr1 = eina_list_last(mro);
while (itr1)
{
itr2 = eina_list_prev(itr1);
while (itr2)
{
itr2n = eina_list_prev(itr2);
if (eina_list_data_get(itr1) == eina_list_data_get(itr2))
{
mro = eina_list_remove_list(mro, itr2);
}
itr2 = itr2n;
}
itr1 = eina_list_prev(itr1);
}
}
/* Copy the mro and free the list. */
{
const Eo_Class *kls_itr;
const Eo_Class **mro_itr;
klass->mro = calloc(sizeof(*klass->mro), eina_list_count(mro) + 1);
mro_itr = klass->mro;
EINA_LIST_FREE(mro, kls_itr)
{
*(mro_itr++) = kls_itr;
DBG("Added '%s' to MRO", kls_itr->desc->name);
}
*(mro_itr) = NULL;
}
DBG("Finished creating MRO for class '%s'", klass->desc->name);
return EINA_TRUE;
}
static void
_eo_class_constructor(Eo_Class *klass)
{
if (klass->constructed)
return;
klass->constructed = EINA_TRUE;
if (klass->desc->class_constructor)
klass->desc->class_constructor(klass);
}
EAPI void
eo_class_funcs_set(Eo_Class *klass, const Eo_Op_Func_Description *func_descs)
{
EO_MAGIC_RETURN(klass, EO_CLASS_EINA_MAGIC);
const Eo_Op_Func_Description *itr;
itr = func_descs;
if (itr)
{
for ( ; itr->op != 0 ; itr++)
{
const Eo_Op_Description *op_desc = _eo_op_id_desc_get(itr->op);
if (EINA_LIKELY(!op_desc || (itr->constant == op_desc->constant)))
{
dich_func_set(klass, itr->op, itr->func);
}
else
{
ERR("Set function's constant property (%d) is different than the one in the op description (%d) for op '%s' in class '%s'.", itr->constant, op_desc->constant, op_desc->name, klass->desc->name);
}
}
}
}
static void
eo_class_free(Eo_Class *klass)
{
if (klass->constructed)
{
if (klass->desc->class_destructor)
klass->desc->class_destructor(klass);
dich_func_clean_all(klass);
}
{
Eina_Inlist *itrn;
Eo_Extension_Node *extn = NULL;
EINA_INLIST_FOREACH_SAFE(klass->extensions, itrn, extn)
{
free(extn);
}
}
if (klass->mro)
free(klass->mro);
if (klass->extn_data_off)
free(klass->extn_data_off);
free(klass);
}
/* DEVCHECK */
static Eina_Bool
_eo_class_check_op_descs(const Eo_Class *klass)
{
const Eo_Class_Description *desc = klass->desc;
const Eo_Op_Description *itr;
size_t i;
if (desc->ops.count > 0)
{
if (!desc->ops.base_op_id)
{
ERR("Class '%s' has a non-zero ops count, but base_id is NULL.",
desc->name);
return EINA_FALSE;
}
if (!desc->ops.descs)
{
ERR("Class '%s' has a non-zero ops count, but there are no descs.",
desc->name);
return EINA_FALSE;
}
}
itr = desc->ops.descs;
for (i = 0 ; i < desc->ops.count ; i++, itr++)
{
if (itr->sub_op != i)
{
if (itr->name)
{
ERR("Wrong order in Ops description for class '%s'. Expected %d and got %d", desc->name, i, itr->sub_op);
}
else
{
ERR("Found too few Ops description for class '%s'. Expected %d descriptions, but found %d.", desc->name, desc->ops.count, i);
}
return EINA_FALSE;
}
}
if (itr && itr->name)
{
ERR("Found extra Ops description for class '%s'. Expected %d descriptions, but found more.", desc->name, desc->ops.count);
return EINA_FALSE;
}
return EINA_TRUE;
}
EAPI const Eo_Class *
eo_class_new(const Eo_Class_Description *desc, const Eo_Class *parent, ...)
{
Eo_Class *klass;
va_list p_list;
if (parent && !EINA_MAGIC_CHECK(parent, EO_CLASS_EINA_MAGIC))
{
EINA_MAGIC_FAIL(parent, EO_CLASS_EINA_MAGIC);
return NULL;
}
va_start(p_list, parent);
EINA_SAFETY_ON_NULL_RETURN_VAL(desc, NULL);
EINA_SAFETY_ON_NULL_RETURN_VAL(desc->name, NULL);
/* Check restrictions on Interface types. */
if (desc->type == EO_CLASS_TYPE_INTERFACE)
{
EINA_SAFETY_ON_FALSE_RETURN_VAL(!desc->constructor, NULL);
EINA_SAFETY_ON_FALSE_RETURN_VAL(!desc->destructor, NULL);
EINA_SAFETY_ON_FALSE_RETURN_VAL(!desc->class_constructor, NULL);
EINA_SAFETY_ON_FALSE_RETURN_VAL(!desc->class_destructor, NULL);
EINA_SAFETY_ON_FALSE_RETURN_VAL(!desc->data_size, NULL);
}
klass = calloc(1, sizeof(Eo_Class));
klass->parent = parent;
/* Handle class extensions */
{
Eo_Class *extn = NULL;
extn = va_arg(p_list, Eo_Class *);
while (extn)
{
switch (extn->desc->type)
{
case EO_CLASS_TYPE_REGULAR:
case EO_CLASS_TYPE_REGULAR_NO_INSTANT:
/* Use it like an interface. */
case EO_CLASS_TYPE_INTERFACE:
break;
case EO_CLASS_TYPE_MIXIN:
{
Eo_Extension_Node *node = calloc(1, sizeof(*node));
node->klass = extn;
klass->extensions =
eina_inlist_append(klass->extensions,
EINA_INLIST_GET(node));
}
break;
}
extn = va_arg(p_list, Eo_Class *);
}
}
klass->desc = desc;
/* Handle the inheritance */
if (klass->parent)
{
/* Verify the inheritance is allowed. */
switch (klass->desc->type)
{
case EO_CLASS_TYPE_REGULAR:
case EO_CLASS_TYPE_REGULAR_NO_INSTANT:
if ((klass->parent->desc->type != EO_CLASS_TYPE_REGULAR) &&
(klass->parent->desc->type != EO_CLASS_TYPE_REGULAR_NO_INSTANT))
{
ERR("Regular classes ('%s') aren't allowed to inherit from non-regular classes ('%s').", klass->desc->name, klass->parent->desc->name);
goto cleanup;
}
break;
case EO_CLASS_TYPE_INTERFACE:
case EO_CLASS_TYPE_MIXIN:
if ((klass->parent->desc->type != EO_CLASS_TYPE_INTERFACE) &&
(klass->parent->desc->type != EO_CLASS_TYPE_MIXIN))
{
ERR("Non-regular classes ('%s') aren't allowed to inherit from regular classes ('%s').", klass->desc->name, klass->parent->desc->name);
goto cleanup;
}
break;
}
/* Update the current offset. */
/* FIXME: Make sure this alignment is enough. */
klass->data_offset = klass->parent->data_offset +
EO_ALIGN_SIZE(klass->parent->desc->data_size);
}
if (!_eo_class_check_op_descs(klass))
{
goto cleanup;
}
if (!_eo_class_mro_init(klass))
{
goto cleanup;
}
/* create MIXIN offset table. */
{
const Eo_Class **mro_itr = klass->mro;
Eo_Extension_Data_Offset *extn_data_itr;
size_t extn_num = 0;
size_t extn_data_off = klass->data_offset +
EO_ALIGN_SIZE(klass->desc->data_size);
/* FIXME: Make faster... */
while (*mro_itr)
{
if (((*mro_itr)->desc->type == EO_CLASS_TYPE_MIXIN) &&
((*mro_itr)->desc->data_size > 0))
{
extn_num++;
}
mro_itr++;
}
klass->extn_data_off = calloc(extn_num + 1,
sizeof(*klass->extn_data_off));
extn_data_itr = klass->extn_data_off;
mro_itr = klass->mro;
while (*mro_itr)
{
if (((*mro_itr)->desc->type == EO_CLASS_TYPE_MIXIN) &&
((*mro_itr)->desc->data_size > 0))
{
extn_data_itr->klass = *mro_itr;
extn_data_itr->offset = extn_data_off;
extn_data_off += EO_ALIGN_SIZE(extn_data_itr->klass->desc->data_size);
extn_data_itr++;
}
mro_itr++;
}
klass->extn_data_size = extn_data_off;
}
eina_lock_take(&_eo_class_creation_lock);
klass->class_id = ++_eo_classes_last_id;
{
/* FIXME: Handle errors. */
Eo_Class **tmp;
tmp = realloc(_eo_classes, _eo_classes_last_id * sizeof(*_eo_classes));
_eo_classes = tmp;
_eo_classes[klass->class_id - 1] = klass;
}
eina_lock_release(&_eo_class_creation_lock);
EINA_MAGIC_SET(klass, EO_CLASS_EINA_MAGIC);
_eo_class_base_op_init(klass);
_eo_class_constructor(klass);
va_end(p_list);
return klass;
cleanup:
eo_class_free(klass);
return NULL;
}
EAPI Eo *
eo_add(const Eo_Class *klass, Eo *parent)
{
EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, NULL);
if (parent) EO_MAGIC_RETURN_VAL(parent, EO_EINA_MAGIC, NULL);
if (EINA_UNLIKELY(klass->desc->type != EO_CLASS_TYPE_REGULAR))
{
ERR("Class '%s' is not instantiate-able. Aborting.", klass->desc->name);
return NULL;
}
Eo *obj = calloc(1, EO_ALIGN_SIZE(sizeof(*obj)) +
(klass->data_offset + EO_ALIGN_SIZE(klass->desc->data_size)) +
klass->extn_data_size);
obj->klass = klass;
obj->parent = parent;
obj->refcount++;
_eo_kls_itr_init(obj, EO_NOOP);
eo_constructor_error_unset(obj);
EINA_MAGIC_SET(obj, EO_EINA_MAGIC);
eo_ref(obj);
_eo_constructor(obj, klass);
if (EINA_UNLIKELY(eo_constructor_error_get(obj)))
{
ERR("Type '%s' - One of the object constructors have failed.", klass->desc->name);
goto fail;
}
if (EINA_UNLIKELY(!_eo_kls_itr_reached_end(obj)))
{
ERR("Type '%s' - Not all of the object constructors have been executed.", klass->desc->name);
goto fail;
}
_eo_kls_itr_end(obj, EO_NOOP);
eo_unref(obj);
return obj;
fail:
/* Unref twice, once for the ref above, and once for the basic object ref. */
eo_unref(obj);
eo_unref(obj);
return NULL;
}
typedef struct
{
EINA_INLIST;
const Eo *ref_obj;
const char *file;
int line;
} Eo_Xref_Node;
EAPI Eo *
eo_xref_internal(Eo *obj, const Eo *ref_obj, const char *file, int line)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, obj);
eo_ref(obj);
#ifndef NDEBUG
Eo_Xref_Node *xref = calloc(1, sizeof(*xref));
xref->ref_obj = ref_obj;
xref->file = file;
xref->line = line;
/* FIXME: Make it sorted. */
obj->xrefs = eina_inlist_prepend(obj->xrefs, EINA_INLIST_GET(xref));
#else
(void) ref_obj;
(void) file;
(void) line;
#endif
return obj;
}
EAPI void
eo_xunref(Eo *obj, const Eo *ref_obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
#ifndef NDEBUG
Eo_Xref_Node *xref = NULL;
EINA_INLIST_FOREACH(obj->xrefs, xref)
{
if (xref->ref_obj == ref_obj)
break;
}
if (xref)
{
obj->xrefs = eina_inlist_remove(obj->xrefs, EINA_INLIST_GET(xref));
free(xref);
}
else
{
ERR("ref_obj (%p) does not reference obj (%p). Aborting unref.", ref_obj, obj);
return;
}
#else
(void) ref_obj;
#endif
eo_unref(obj);
}
EAPI Eo *
eo_ref(Eo *obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, obj);
obj->refcount++;
return obj;
}
static void
_eo_del_internal(Eo *obj)
{
if (obj->delete)
return;
/* We need that for the event callbacks that may ref/unref. */
obj->refcount++;
eo_event_callback_call(obj, EO_EV_DEL, NULL);
obj->delete = EINA_TRUE;
obj->refcount--;
const Eo_Class *klass = eo_class_get(obj);
_eo_kls_itr_init(obj, EO_NOOP);
eo_constructor_error_unset(obj);
_eo_destructor(obj, klass);
if (eo_constructor_error_get(obj))
{
ERR("Type '%s' - One of the object destructors have failed.", klass->desc->name);
}
if (!_eo_kls_itr_reached_end(obj))
{
ERR("Type '%s' - Not all of the object destructors have been executed.", klass->desc->name);
}
_eo_kls_itr_end(obj, EO_NOOP);
/*FIXME: add eo_class_unref(klass) ? - just to clear the caches. */
/* If for some reason it's not empty, clear it. */
while (obj->kls_itr)
{
WRN("Kls_Itr is not empty, possibly a bug, please report. - An error will be reported for each kls_itr in the stack.");
Eina_Inlist *nitr = obj->kls_itr->next;
free(EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eo_Kls_Itr_Node));
obj->kls_itr = nitr;
}
Eina_List *itr, *itr_n;
Eo *emb_obj;
EINA_LIST_FOREACH_SAFE(obj->composite_objects, itr, itr_n, emb_obj)
{
eo_composite_object_detach(obj, emb_obj);
}
}
EAPI void
eo_unref(Eo *obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
if (--(obj->refcount) == 0)
{
_eo_del_internal(obj);
/* We need that for the event callbacks that may ref/unref. */
obj->refcount++;
eo_event_callback_call(obj, EO_EV_FREE, NULL);
obj->refcount--;
#ifndef NDEBUG
/* If for some reason it's not empty, clear it. */
while (obj->xrefs)
{
WRN("obj->xrefs is not empty, possibly a bug, please report. - An error will be reported for each xref in the stack.");
Eina_Inlist *nitr = obj->xrefs->next;
free(EINA_INLIST_CONTAINER_GET(obj->xrefs, Eo_Kls_Itr_Node));
obj->xrefs = nitr;
}
#endif
_eo_callback_remove_all(obj);
free(obj);
}
}
EAPI int
eo_ref_get(const Eo *obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, 0);
return obj->refcount;
}
EAPI void
eo_del(Eo *obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
_eo_del_internal(obj);
eo_unref(obj);
}
EAPI Eo *
eo_parent_get(Eo *obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, NULL);
return obj->parent;
}
EAPI void
eo_constructor_error_set(Eo *obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
obj->construct_error = EINA_TRUE;
}
static void
eo_constructor_error_unset(Eo *obj)
{
obj->construct_error = EINA_FALSE;
}
EAPI Eina_Bool
eo_constructor_error_get(const Eo *obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_TRUE);
return obj->construct_error;
}
static inline void
_eo_constructor_default(Eo *obj)
{
eo_constructor_super(obj);
}
static inline void
_eo_destructor_default(Eo *obj)
{
eo_destructor_super(obj);
}
static void
_eo_constructor(Eo *obj, const Eo_Class *klass)
{
if (!klass)
return;
if (klass->desc->constructor)
klass->desc->constructor(obj, eo_data_get(obj, klass));
else
_eo_constructor_default(obj);
}
static void
_eo_destructor(Eo *obj, const Eo_Class *klass)
{
if (!klass)
return;
if (klass->desc->destructor)
klass->desc->destructor(obj, eo_data_get(obj, klass));
else
_eo_destructor_default(obj);
}
EAPI void
eo_constructor_super(Eo *obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
_eo_constructor(obj, _eo_kls_itr_next(obj, EO_NOOP));
}
EAPI void
eo_destructor_super(Eo *obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
_eo_destructor(obj, _eo_kls_itr_next(obj, EO_NOOP));
}
EAPI void *
eo_data_get(const Eo *obj, const Eo_Class *klass)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, NULL);
#ifndef NDEBUG
if (!_eo_class_mro_has(obj->klass, klass))
{
ERR("Tried getting data of class '%s' from object of class '%s', but the former is not a direct inheritance of the latter.", klass->desc->name, obj->klass->desc->name);
return NULL;
}
#endif
if (EINA_LIKELY(klass->desc->data_size > 0))
{
if (EINA_UNLIKELY(klass->desc->type == EO_CLASS_TYPE_MIXIN))
{
Eo_Extension_Data_Offset *doff_itr =
eo_class_get(obj)->extn_data_off;
if (!doff_itr)
return NULL;
while (doff_itr->klass)
{
if (doff_itr->klass == klass)
return ((char *) obj) + EO_ALIGN_SIZE(sizeof(*obj)) +
doff_itr->offset;
doff_itr++;
}
}
else
{
return ((char *) obj) + EO_ALIGN_SIZE(sizeof(*obj)) +
klass->data_offset;
}
}
return NULL;
}
EAPI Eina_Bool
eo_init(void)
{
const char *log_dom = "eo";
if (_eo_init_count++ > 0)
return EINA_TRUE;
eina_init();
_eo_classes = NULL;
_eo_classes_last_id = 0;
_eo_log_dom = eina_log_domain_register(log_dom, EINA_COLOR_LIGHTBLUE);
if (_eo_log_dom < 0)
{
EINA_LOG_ERR("Could not register log domain: %s", log_dom);
return EINA_FALSE;
}
if (!eina_lock_new(&_eo_class_creation_lock))
{
EINA_LOG_ERR("Could not init lock.");
return EINA_FALSE;
}
eina_magic_string_static_set(EO_EINA_MAGIC, EO_EINA_MAGIC_STR);
eina_magic_string_static_set(EO_CLASS_EINA_MAGIC,
EO_CLASS_EINA_MAGIC_STR);
return EINA_TRUE;
}
EAPI Eina_Bool
eo_shutdown(void)
{
int i;
Eo_Class **cls_itr = _eo_classes;
if (--_eo_init_count > 0)
return EINA_TRUE;
for (i = 0 ; i < _eo_classes_last_id ; i++, cls_itr++)
{
if (*cls_itr)
eo_class_free(*cls_itr);
}
if (_eo_classes)
free(_eo_classes);
eina_lock_free(&_eo_class_creation_lock);
eina_log_domain_unregister(_eo_log_dom);
_eo_log_dom = -1;
eina_shutdown();
return EINA_TRUE;
}
EAPI void
eo_composite_object_attach(Eo *obj, Eo *emb_obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
EO_MAGIC_RETURN(emb_obj, EO_EINA_MAGIC);
eo_xref(emb_obj, obj);
obj->composite_objects = eina_list_prepend(obj->composite_objects, emb_obj);
}
EAPI void
eo_composite_object_detach(Eo *obj, Eo *emb_obj)
{
EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
EO_MAGIC_RETURN(emb_obj, EO_EINA_MAGIC);
obj->composite_objects = eina_list_remove(obj->composite_objects, emb_obj);
eo_xunref(emb_obj, obj);
}
EAPI Eina_Bool
eo_composite_is(Eo *emb_obj)
{
if (!EINA_MAGIC_CHECK(emb_obj, EO_EINA_MAGIC))
{
EINA_MAGIC_FAIL(emb_obj, EO_EINA_MAGIC);
return EINA_FALSE;
}
Eo *obj = eo_parent_get(emb_obj);
Eina_List *itr;
Eo *tmp;
if (!obj)
return EINA_FALSE;
EINA_LIST_FOREACH(obj->composite_objects, itr, tmp)
{
if (tmp == emb_obj)
return EINA_TRUE;
}
return EINA_FALSE;
}
/* Callbacks */
struct _Eo_Callback_Description
{
EINA_INLIST;
const Eo_Event_Description *event;
Eo_Event_Cb func;
void *func_data;
Eo_Callback_Priority priority;
Eina_Bool delete_me : 1;
};
/* Actually remove, doesn't care about walking list, or delete_me */
static void
_eo_callback_remove(Eo *obj, Eo_Callback_Description *cb)
{
obj->callbacks = eina_inlist_remove(obj->callbacks,
EINA_INLIST_GET(cb));
free(cb);
}
/* Actually remove, doesn't care about walking list, or delete_me */
static void
_eo_callback_remove_all(Eo *obj)
{
Eina_Inlist *initr;
Eo_Callback_Description *cb = NULL;
EINA_INLIST_FOREACH_SAFE(obj->callbacks, initr, cb)
{
_eo_callback_remove(obj, cb);
}
}
static void
_eo_callbacks_clear(Eo *obj)
{
Eina_Inlist *itn;
Eo_Callback_Description *cb = NULL;
/* Abort if we are currently walking the list. */
if (obj->walking_list > 0)
return;
EINA_INLIST_FOREACH_SAFE(obj->callbacks, itn, cb)
{
if (cb->delete_me)
{
_eo_callback_remove(obj, cb);
}
}
}
static int
_callback_priority_cmp(const void *_a, const void *_b)
{
const Eo_Callback_Description *a, *b;
a = (const Eo_Callback_Description *) _a;
b = (const Eo_Callback_Description *) _b;
if (a->priority < b->priority)
return -1;
else
return 1;
}
EAPI Eina_Bool
eo_event_callback_priority_add(Eo *obj,
const Eo_Event_Description *desc,
Eo_Callback_Priority priority,
Eo_Event_Cb func,
const void *data)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
Eo_Callback_Description *cb = calloc(1, sizeof(*cb));
cb->event = desc;
cb->func = func;
cb->func_data = (void *) data;
cb->priority = priority;
obj->callbacks = eina_inlist_sorted_insert(obj->callbacks,
EINA_INLIST_GET(cb), _callback_priority_cmp);
eo_event_callback_call(obj, EO_EV_CALLBACK_ADD, desc);
return EINA_TRUE;
}
EAPI void *
eo_event_callback_del_lazy(Eo *obj, const Eo_Event_Description *desc, Eo_Event_Cb func)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, NULL);
void *ret = NULL;
Eo_Callback_Description *cb;
EINA_INLIST_FOREACH(obj->callbacks, cb)
{
if ((cb->event == desc) && (cb->func == func))
{
void *data;
data = cb->func_data;
cb->delete_me = EINA_TRUE;
_eo_callbacks_clear(obj);
ret = data;
goto found;
}
}
return NULL;
found:
eo_event_callback_call(obj, EO_EV_CALLBACK_DEL, desc);
return ret;
}
EAPI void *
eo_event_callback_del(Eo *obj, const Eo_Event_Description *desc, Eo_Event_Cb func, const void *user_data)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, NULL);
void *ret = NULL;
Eo_Callback_Description *cb;
EINA_INLIST_FOREACH(obj->callbacks, cb)
{
if ((cb->event == desc) && (cb->func == func) &&
(cb->func_data == user_data))
{
void *data;
data = cb->func_data;
cb->delete_me = EINA_TRUE;
_eo_callbacks_clear(obj);
ret = data;
goto found;
}
}
return NULL;
found:
eo_event_callback_call(obj, EO_EV_CALLBACK_DEL, desc);
return ret;
}
EAPI Eina_Bool
eo_event_callback_call(Eo *obj, const Eo_Event_Description *desc,
const void *event_info)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
Eina_Bool ret = EINA_TRUE;
Eo_Callback_Description *cb;
eo_ref(obj);
obj->walking_list++;
EINA_INLIST_FOREACH(obj->callbacks, cb)
{
if (!cb->delete_me && (cb->event == desc))
{
/* Abort callback calling if the func says so. */
if (!cb->func((void *) cb->func_data, obj, desc,
(void *) event_info))
{
ret = EINA_FALSE;
break;
}
}
if (obj->delete)
break;
}
obj->walking_list--;
_eo_callbacks_clear(obj);
eo_unref(obj);
return ret;
}
static Eina_Bool
_eo_event_forwarder_callback(void *data, Eo *obj, const Eo_Event_Description *desc, void *event_info)
{
(void) obj;
Eo *new_obj = (Eo *) data;
return eo_event_callback_call(new_obj, desc, event_info);
}
/* FIXME: Change default priority? Maybe call later? */
EAPI Eina_Bool
eo_event_callback_forwarder_add(Eo *obj, const Eo_Event_Description *desc, Eo *new_obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
EO_MAGIC_RETURN_VAL(new_obj, EO_EINA_MAGIC, EINA_FALSE);
return eo_event_callback_add(obj, desc, _eo_event_forwarder_callback, new_obj);
}
EAPI Eina_Bool
eo_event_callback_forwarder_del(Eo *obj, const Eo_Event_Description *desc, Eo *new_obj)
{
EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
EO_MAGIC_RETURN_VAL(new_obj, EO_EINA_MAGIC, EINA_FALSE);
eo_event_callback_del(obj, desc, _eo_event_forwarder_callback, new_obj);
return EINA_TRUE;
}