4 #include "eo_private.h"
8 /* The last id that should be reserved for statically allocated classes. */
9 #define EO_STATIC_IDS_LAST 10
10 #define EO_OP_IDS_FIRST 1
12 /* Used inside the class_get functions of classes, see #EO_DEFINE_CLASS */
13 EAPI Eina_Lock _eo_class_creation_lock;
16 static Eo_Class **_eo_classes;
17 static Eo_Class_Id _eo_classes_last_id;
18 static Eina_Bool _eo_init_count = 0;
19 static Eo_Op _eo_ops_last_id = 0;
21 static void _eo_condtor_reset(Eo *obj);
22 static inline void *_eo_data_get(const Eo *obj, const Eo_Class *klass);
23 static inline Eo *_eo_ref(Eo *obj);
24 static inline void _eo_unref(Eo *obj);
25 static const Eo_Class *_eo_op_class_get(Eo_Op op);
26 static const Eo_Op_Description *_eo_op_id_desc_get(Eo_Op op);
37 Eina_Inlist *children;
38 const Eo_Class *klass;
44 Eina_List *composite_objects;
49 Eina_Bool condtor_done:1;
51 Eina_Bool composite:1;
53 Eina_Bool manual_free:1;
58 /* How we search and store the implementations in classes. */
59 #define DICH_CHAIN_LAST_BITS 5
60 #define DICH_CHAIN_LAST_SIZE (1 << DICH_CHAIN_LAST_BITS)
61 #define DICH_CHAIN1(x) ((x) / DICH_CHAIN_LAST_SIZE)
62 #define DICH_CHAIN_LAST(x) ((x) % DICH_CHAIN_LAST_SIZE)
64 #define OP_CLASS_OFFSET_GET(x) (((x) >> EO_OP_CLASS_OFFSET) & 0xffff)
66 #define ID_CLASS_GET(id) ({ \
67 (Eo_Class *) ((id <= _eo_classes_last_id) && (id > 0)) ? \
68 (_eo_classes[id - 1]) : NULL; \
71 #define EO_ALIGN_SIZE(size) \
72 ((size) + (sizeof(void *) - ((size) % sizeof(void *))))
74 typedef struct _Dich_Chain1 Dich_Chain1;
89 const Eo_Class *klass;
91 } Eo_Extension_Data_Offset;
97 const Eo_Class *parent;
98 const Eo_Class_Description *desc;
99 Dich_Chain1 *chain; /**< The size is chain size */
103 const Eo_Class **extensions;
105 Eo_Extension_Data_Offset *extn_data_off;
106 size_t extn_data_size;
108 const Eo_Class **mro;
111 size_t data_offset; /* < Offset of the data within object data. */
113 Eina_Bool constructed : 1;
117 _dich_chain_alloc(Dich_Chain1 *chain1)
121 chain1->funcs = calloc(DICH_CHAIN_LAST_SIZE, sizeof(*(chain1->funcs)));
126 _dich_copy_all(Eo_Class *dst, const Eo_Class *src)
129 const Dich_Chain1 *sc1 = src->chain;
130 Dich_Chain1 *dc1 = dst->chain;
131 for (i = 0 ; i < src->chain_size ; i++, sc1++, dc1++)
137 _dich_chain_alloc(dc1);
139 const op_type_funcs *sf = sc1->funcs;
140 op_type_funcs *df = dc1->funcs;
141 for (j = 0 ; j < DICH_CHAIN_LAST_SIZE ; j++, df++, sf++)
145 memcpy(df, sf, sizeof(*df));
152 static inline const op_type_funcs *
153 _dich_func_get(const Eo_Class *klass, Eo_Op op)
155 size_t idx1 = DICH_CHAIN1(op);
156 if (EINA_UNLIKELY(idx1 >= klass->chain_size))
158 Dich_Chain1 *chain1 = &klass->chain[idx1];
159 if (EINA_UNLIKELY(!chain1->funcs))
161 return &chain1->funcs[DICH_CHAIN_LAST(op)];
165 _dich_func_set(Eo_Class *klass, Eo_Op op, eo_op_func_type func)
167 size_t idx1 = DICH_CHAIN1(op);
168 Dich_Chain1 *chain1 = &klass->chain[idx1];
169 _dich_chain_alloc(chain1);
170 if (chain1->funcs[DICH_CHAIN_LAST(op)].src == klass)
172 const Eo_Class *op_kls = _eo_op_class_get(op);
173 const Eo_Op_Description *op_desc = _eo_op_id_desc_get(op);
174 ERR("Already set function for op %x (%s:%s). Overriding with func %p",
175 op, op_kls->desc->name, op_desc->name, func);
178 chain1->funcs[DICH_CHAIN_LAST(op)].func = func;
179 chain1->funcs[DICH_CHAIN_LAST(op)].src = klass;
183 _dich_func_clean_all(Eo_Class *klass)
186 Dich_Chain1 *chain1 = klass->chain;
188 for (i = 0 ; i < klass->chain_size ; i++, chain1++)
199 static const Eo_Op_Description noop_desc =
200 EO_OP_DESCRIPTION(EO_NOOP, "No operation.");
202 static const Eo_Class *
203 _eo_op_class_get(Eo_Op op)
205 /* FIXME: Make it fast. */
206 const Eo_Class *klass = NULL;
207 Eo_Class **itr = _eo_classes;
209 for (i = 0 ; i < _eo_classes_last_id ; i++, itr++)
211 if (*itr && ((*itr)->base_id <= op) &&
212 (op <= (*itr)->base_id + (*itr)->desc->ops.count))
222 static const Eo_Op_Description *
223 _eo_op_id_desc_get(Eo_Op op)
225 const Eo_Class *klass;
230 klass = _eo_op_class_get(op);
234 Eo_Op sub_id = op - klass->base_id;
235 if (sub_id < klass->desc->ops.count)
236 return klass->desc->ops.descs + sub_id;
243 _eo_op_id_name_get(Eo_Op op)
245 const Eo_Op_Description *desc = _eo_op_id_desc_get(op);
246 return (desc) ? desc->name : NULL;
250 _eo_kls_itr_init(const Eo_Class *obj_klass, Eo_Kls_Itr *cur, Eo_Kls_Itr *prev_state)
252 memcpy(prev_state, cur, sizeof(*cur));
253 cur->kls = *obj_klass->mro;
257 _eo_kls_itr_end(Eo_Kls_Itr *cur, Eo_Kls_Itr *prev_state)
259 memcpy(cur, prev_state, sizeof(*cur));
262 static inline const Eo_Class *
263 _eo_kls_itr_get(Eo_Kls_Itr *cur)
269 _eo_kls_itr_set(Eo_Kls_Itr *cur, const Eo_Class *kls)
274 static inline const Eo_Class *
275 _eo_kls_itr_next(const Eo_Class *orig_kls, Eo_Kls_Itr *cur, Eo_Kls_Itr *prev_state, Eo_Op op)
277 const Eo_Class **kls_itr = NULL;
278 memcpy(prev_state, cur, sizeof(*cur));
280 /* Find the kls itr. */
281 kls_itr = orig_kls->mro;
282 while (*kls_itr && (*kls_itr != cur->kls))
290 const op_type_funcs *fsrc = _dich_func_get(*kls_itr, op);
291 cur->kls = fsrc->src;
299 static inline const op_type_funcs *
300 _eo_kls_itr_func_get(Eo_Kls_Itr *mro_itr, Eo_Op op)
302 const Eo_Class *klass = _eo_kls_itr_get(mro_itr);
305 const op_type_funcs *func = _dich_func_get(klass, op);
307 if (func && func->func)
309 _eo_kls_itr_set(mro_itr, func->src);
314 _eo_kls_itr_set(mro_itr, NULL);
318 #define _EO_OP_ERR_NO_OP_PRINT(op, klass) \
321 const Eo_Class *op_klass = _eo_op_class_get(op); \
322 const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL; \
323 ERR("Can't find func for op %x (%s:%s) for class '%s'. Aborting.", \
324 op, _dom_name, _eo_op_id_name_get(op), \
325 (klass) ? klass->desc->name : NULL); \
330 _eo_op_internal(Eo *obj, Eo_Op_Type op_type, Eo_Op op, va_list *p_list)
333 const Eo_Op_Description *op_desc = _eo_op_id_desc_get(op);
337 if (op_desc->op_type == EO_OP_TYPE_CLASS)
339 ERR("Tried calling a class op '%s' (%x) from a non-class context.", (op_desc) ? op_desc->name : NULL, op);
346 const op_type_funcs *func =
347 _eo_kls_itr_func_get(&obj->mro_itr, op);
350 func->func(obj, _eo_data_get(obj, func->src), p_list);
355 /* Try composite objects */
359 EINA_LIST_FOREACH(obj->composite_objects, itr, emb_obj)
361 /* FIXME: Clean this up a bit. */
362 Eo_Kls_Itr prev_state;
363 _eo_kls_itr_init(emb_obj->klass, &emb_obj->mro_itr, &prev_state);
364 if (_eo_op_internal(emb_obj, op_type, op, p_list))
366 _eo_kls_itr_end(&emb_obj->mro_itr, &prev_state);
369 _eo_kls_itr_end(&emb_obj->mro_itr, &prev_state);
376 eo_do_internal(Eo *obj, Eo_Op_Type op_type, ...)
378 Eina_Bool prev_error;
379 Eina_Bool ret = EINA_TRUE;
381 Eo_Kls_Itr prev_state;
384 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
386 prev_error = obj->do_error;
389 va_start(p_list, op_type);
391 op = va_arg(p_list, Eo_Op);
394 _eo_kls_itr_init(obj->klass, &obj->mro_itr, &prev_state);
395 if (!_eo_op_internal(obj, op_type, op, &p_list))
397 _EO_OP_ERR_NO_OP_PRINT(op, obj->klass);
399 _eo_kls_itr_end(&obj->mro_itr, &prev_state);
402 op = va_arg(p_list, Eo_Op);
403 _eo_kls_itr_end(&obj->mro_itr, &prev_state);
413 obj->do_error = prev_error;
419 eo_do_super_internal(Eo *obj, Eo_Op_Type op_type, Eo_Op op, ...)
421 const Eo_Class *nklass;
422 Eina_Bool ret = EINA_TRUE;
424 Eo_Kls_Itr prev_state;
425 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
427 /* Advance the kls itr. */
428 nklass = _eo_kls_itr_next(obj->klass, &obj->mro_itr, &prev_state, op);
430 va_start(p_list, op);
431 if (!_eo_op_internal(obj, op_type, op, &p_list))
433 _EO_OP_ERR_NO_OP_PRINT(op, nklass);
441 _eo_kls_itr_end(&obj->mro_itr, &prev_state);
446 _eo_class_op_internal(Eo_Class *klass, Eo_Op op, va_list *p_list)
449 const Eo_Op_Description *op_desc = _eo_op_id_desc_get(op);
453 if (op_desc->op_type != EO_OP_TYPE_CLASS)
455 ERR("Tried calling an instance op '%s' (%x) from a class context.", (op_desc) ? op_desc->name : NULL, op);
462 const op_type_funcs *func =
463 _eo_kls_itr_func_get(&klass->mro_itr, op);
466 ((eo_op_func_type_class) func->func)(klass, p_list);
475 eo_class_do_internal(const Eo_Class *klass, ...)
477 Eina_Bool ret = EINA_TRUE;
479 Eo_Kls_Itr prev_state;
482 EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, EINA_FALSE);
484 va_start(p_list, klass);
486 op = va_arg(p_list, Eo_Op);
489 _eo_kls_itr_init(klass, &((Eo_Class *) klass)->mro_itr, &prev_state);
490 if (!_eo_class_op_internal((Eo_Class *) klass, op, &p_list))
492 _EO_OP_ERR_NO_OP_PRINT(op, klass);
494 _eo_kls_itr_end(&((Eo_Class *) klass)->mro_itr, &prev_state);
497 _eo_kls_itr_end(&((Eo_Class *) klass)->mro_itr, &prev_state);
498 op = va_arg(p_list, Eo_Op);
507 eo_class_do_super_internal(const Eo_Class *klass, Eo_Op op, ...)
509 const Eo_Class *nklass;
510 Eina_Bool ret = EINA_TRUE;
512 Eo_Kls_Itr prev_state;
513 EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, EINA_FALSE);
515 /* Advance the kls itr. */
516 nklass = _eo_kls_itr_next(klass, &((Eo_Class *) klass)->mro_itr, &prev_state, op);
518 va_start(p_list, op);
519 if (!_eo_class_op_internal((Eo_Class *) klass, op, &p_list))
521 _EO_OP_ERR_NO_OP_PRINT(op, nklass);
526 _eo_kls_itr_end(&((Eo_Class *) klass)->mro_itr, &prev_state);
530 EAPI const Eo_Class *
531 eo_class_get(const Eo *obj)
533 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
539 eo_class_name_get(const Eo_Class *klass)
541 EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, NULL);
543 return klass->desc->name;
547 _eo_class_base_op_init(Eo_Class *klass)
549 const Eo_Class_Description *desc = klass->desc;
551 klass->base_id = _eo_ops_last_id;
553 if (desc && desc->ops.base_op_id)
554 *(desc->ops.base_op_id) = klass->base_id;
556 _eo_ops_last_id += desc->ops.count + 1;
558 klass->chain_size = DICH_CHAIN1(_eo_ops_last_id) + 1;
559 klass->chain = calloc(klass->chain_size, sizeof(*klass->chain));
564 _eo_class_mro_has(const Eo_Class *klass, const Eo_Class *find)
566 const Eo_Class **itr;
567 for (itr = klass->mro ; *itr ; itr++)
579 _eo_class_mro_add(Eina_List *mro, const Eo_Class *klass)
581 Eina_List *extn_pos = NULL;
582 Eina_Bool check_consistency = !mro;
586 mro = eina_list_append(mro, klass);
588 /* ONLY ADD MIXINS! */
590 /* Recursively add extenions. */
592 const Eo_Class **extn_itr;
594 for (extn_itr = klass->extensions ; *extn_itr ; extn_itr++)
596 const Eo_Class *extn = *extn_itr;
597 if (extn->desc->type != EO_CLASS_TYPE_MIXIN)
600 mro = _eo_class_mro_add(mro, extn);
601 /* Not possible: if (!mro) return NULL; */
603 if (check_consistency)
605 extn_pos = eina_list_append(extn_pos, eina_list_last(mro));
610 /* Check if we can create a consistent mro. We only do it for the class
611 * we are working on (i.e no parents). */
612 if (check_consistency)
614 const Eo_Class **extn_itr;
616 Eina_List *itr = extn_pos;
617 for (extn_itr = klass->extensions ; *extn_itr ; extn_itr++)
619 const Eo_Class *extn = *extn_itr;
620 if (extn->desc->type != EO_CLASS_TYPE_MIXIN)
623 /* Get the first one after the extension. */
624 Eina_List *extn_list = eina_list_next(eina_list_data_get(itr));
626 /* If we found the extension again. */
627 if (eina_list_data_find_list(extn_list, extn))
630 ERR("Cannot create a consistent method resolution order for class '%s' because of '%s'.", klass->desc->name, extn->desc->name);
634 itr = eina_list_next(itr);
639 mro = _eo_class_mro_add(mro, klass->parent);
645 _eo_class_mro_init(Eo_Class *klass)
647 Eina_List *mro = NULL;
649 DBG("Started creating MRO for class '%s'", klass->desc->name);
650 mro = _eo_class_mro_add(mro, klass);
655 /* Remove duplicates and make them the right order. */
657 Eina_List *itr1, *itr2, *itr2n;
659 itr1 = eina_list_last(mro);
662 itr2 = eina_list_prev(itr1);
666 itr2n = eina_list_prev(itr2);
668 if (eina_list_data_get(itr1) == eina_list_data_get(itr2))
670 mro = eina_list_remove_list(mro, itr2);
676 itr1 = eina_list_prev(itr1);
680 /* Copy the mro and free the list. */
682 const Eo_Class *kls_itr;
683 const Eo_Class **mro_itr;
684 klass->mro = calloc(sizeof(*klass->mro), eina_list_count(mro) + 1);
686 mro_itr = klass->mro;
688 EINA_LIST_FREE(mro, kls_itr)
690 *(mro_itr++) = kls_itr;
692 DBG("Added '%s' to MRO", kls_itr->desc->name);
697 DBG("Finished creating MRO for class '%s'", klass->desc->name);
703 _eo_class_constructor(Eo_Class *klass)
705 if (klass->constructed)
708 klass->constructed = EINA_TRUE;
710 if (klass->desc->class_constructor)
711 klass->desc->class_constructor(klass);
715 eo_class_funcs_set(Eo_Class *klass, const Eo_Op_Func_Description *func_descs)
717 EO_MAGIC_RETURN(klass, EO_CLASS_EINA_MAGIC);
719 const Eo_Op_Func_Description *itr;
723 for ( ; itr->op_type != EO_OP_TYPE_INVALID ; itr++)
725 const Eo_Op_Description *op_desc = _eo_op_id_desc_get(itr->op);
727 if (EINA_UNLIKELY(!op_desc || (itr->op == EO_NOOP)))
729 ERR("Setting implementation for non-existent op %x for class '%s'. Func index: %d", itr->op, klass->desc->name, itr - func_descs);
731 else if (EINA_LIKELY(itr->op_type == op_desc->op_type))
733 _dich_func_set(klass, itr->op, itr->func);
737 ERR("Set function's op type (%x) is different than the one in the op description (%d) for op '%s:%s'. Func index: %d",
739 (op_desc) ? op_desc->op_type : EO_OP_TYPE_REGULAR,
741 (op_desc) ? op_desc->name : NULL,
749 eo_class_free(Eo_Class *klass)
751 if (klass->constructed)
753 if (klass->desc->class_destructor)
754 klass->desc->class_destructor(klass);
756 _dich_func_clean_all(klass);
759 free(klass->extensions);
764 if (klass->extn_data_off)
765 free(klass->extn_data_off);
772 _eo_class_check_op_descs(const Eo_Class *klass, Eo_Class_Id id)
774 const Eo_Class_Description *desc = klass->desc;
775 const Eo_Op_Description *itr;
778 if (desc->ops.count > 0)
780 if (((id == 0) || (id > EO_STATIC_IDS_LAST)) && !desc->ops.base_op_id)
782 ERR("Class '%s' has a non-zero ops count, but base_id is NULL.",
787 if (!desc->ops.descs)
789 ERR("Class '%s' has a non-zero ops count, but there are no descs.",
795 itr = desc->ops.descs;
796 for (i = 0 ; i < desc->ops.count ; i++, itr++)
798 if (itr->sub_op != i)
802 ERR("Wrong order in Ops description for class '%s'. Expected %x and got %x", desc->name, i, itr->sub_op);
806 ERR("Found too few Ops description for class '%s'. Expected %x descriptions, but found %x.", desc->name, desc->ops.count, i);
812 if (itr && itr->name)
814 ERR("Found extra Ops description for class '%s'. Expected %d descriptions, but found more.", desc->name, desc->ops.count);
821 /* Not really called, just used for the ptr... */
823 _eo_class_isa_func(Eo *obj EINA_UNUSED, void *class_data EINA_UNUSED, va_list *list EINA_UNUSED)
828 EAPI const Eo_Class *
829 eo_class_new(const Eo_Class_Description *desc, Eo_Class_Id id, const Eo_Class *parent, ...)
834 if (parent && !EINA_MAGIC_CHECK(parent, EO_CLASS_EINA_MAGIC))
836 EINA_MAGIC_FAIL(parent, EO_CLASS_EINA_MAGIC);
840 if (id > EO_STATIC_IDS_LAST)
842 ERR("Tried creating a class with the static id %d while the maximum static id is %d. Aborting.", id, EO_STATIC_IDS_LAST);
846 va_start(p_list, parent);
848 EINA_SAFETY_ON_NULL_RETURN_VAL(desc, NULL);
849 EINA_SAFETY_ON_NULL_RETURN_VAL(desc->name, NULL);
851 /* Check restrictions on Interface types. */
852 if (desc->type == EO_CLASS_TYPE_INTERFACE)
854 EINA_SAFETY_ON_FALSE_RETURN_VAL(!desc->data_size, NULL);
857 klass = calloc(1, sizeof(Eo_Class));
858 klass->parent = parent;
860 /* Handle class extensions */
862 Eina_List *extn_list = NULL;
863 const Eo_Class *extn = NULL;
864 const Eo_Class **extn_itr = NULL;
866 extn = va_arg(p_list, Eo_Class *);
869 switch (extn->desc->type)
871 case EO_CLASS_TYPE_REGULAR:
872 case EO_CLASS_TYPE_REGULAR_NO_INSTANT:
873 case EO_CLASS_TYPE_INTERFACE:
874 case EO_CLASS_TYPE_MIXIN:
875 extn_list = eina_list_append(extn_list, extn);
879 extn = va_arg(p_list, Eo_Class *);
882 klass->extensions = calloc(sizeof(*klass->extensions),
883 eina_list_count(extn_list) + 1);
885 extn_itr = klass->extensions;
886 EINA_LIST_FREE(extn_list, extn)
888 *(extn_itr++) = extn;
894 /* Handle the inheritance */
897 /* Verify the inheritance is allowed. */
898 switch (klass->desc->type)
900 case EO_CLASS_TYPE_REGULAR:
901 case EO_CLASS_TYPE_REGULAR_NO_INSTANT:
902 if ((klass->parent->desc->type != EO_CLASS_TYPE_REGULAR) &&
903 (klass->parent->desc->type != EO_CLASS_TYPE_REGULAR_NO_INSTANT))
905 ERR("Regular classes ('%s') aren't allowed to inherit from non-regular classes ('%s').", klass->desc->name, klass->parent->desc->name);
909 case EO_CLASS_TYPE_INTERFACE:
910 case EO_CLASS_TYPE_MIXIN:
911 if ((klass->parent->desc->type != EO_CLASS_TYPE_INTERFACE) &&
912 (klass->parent->desc->type != EO_CLASS_TYPE_MIXIN))
914 ERR("Non-regular classes ('%s') aren't allowed to inherit from regular classes ('%s').", klass->desc->name, klass->parent->desc->name);
921 /* Update the current offset. */
922 /* FIXME: Make sure this alignment is enough. */
923 klass->data_offset = klass->parent->data_offset +
924 EO_ALIGN_SIZE(klass->parent->desc->data_size);
927 if (!_eo_class_check_op_descs(klass, id))
932 if (!_eo_class_mro_init(klass))
937 /* create MIXIN offset table. */
939 const Eo_Class **mro_itr = klass->mro;
940 Eo_Extension_Data_Offset *extn_data_itr;
942 size_t extn_data_off = klass->data_offset +
943 EO_ALIGN_SIZE(klass->desc->data_size);
945 /* FIXME: Make faster... */
948 if (((*mro_itr)->desc->type == EO_CLASS_TYPE_MIXIN) &&
949 ((*mro_itr)->desc->data_size > 0))
956 klass->extn_data_off = calloc(extn_num + 1,
957 sizeof(*klass->extn_data_off));
959 extn_data_itr = klass->extn_data_off;
960 mro_itr = klass->mro;
963 if (((*mro_itr)->desc->type == EO_CLASS_TYPE_MIXIN) &&
964 ((*mro_itr)->desc->data_size > 0))
966 extn_data_itr->klass = *mro_itr;
967 extn_data_itr->offset = extn_data_off;
969 extn_data_off += EO_ALIGN_SIZE(extn_data_itr->klass->desc->data_size);
975 klass->extn_data_size = extn_data_off;
978 eina_lock_take(&_eo_class_creation_lock);
982 klass->class_id = ++_eo_classes_last_id;
987 if (_eo_classes && _eo_classes[id - 1])
989 ERR("A class with id %d was already defined (%s). Aborting.", id,
990 _eo_classes[id - 1]->desc->name);
991 eina_lock_release(&_eo_class_creation_lock);
995 klass->class_id = id;
1000 /* FIXME: Handle errors. */
1001 size_t arrsize = _eo_classes_last_id * sizeof(*_eo_classes);
1003 tmp = realloc(_eo_classes, arrsize);
1005 /* If it's the first allocation, memset. */
1007 memset(tmp, 0, arrsize);
1010 _eo_classes[klass->class_id - 1] = klass;
1012 eina_lock_release(&_eo_class_creation_lock);
1014 EINA_MAGIC_SET(klass, EO_CLASS_EINA_MAGIC);
1016 _eo_class_base_op_init(klass);
1017 /* Flatten the function array */
1019 const Eo_Class **mro_itr = klass->mro;
1020 for ( ; *mro_itr ; mro_itr++)
1023 /* Skip ourselves. */
1024 for ( mro_itr-- ; mro_itr > klass->mro ; mro_itr--)
1026 _dich_copy_all(klass, *mro_itr);
1030 /* Mark which classes we implement */
1032 const Eo_Class **extn_itr;
1034 for (extn_itr = klass->extensions ; *extn_itr ; extn_itr++)
1036 const Eo_Class *extn = *extn_itr;
1037 /* Set it in the dich. */
1038 _dich_func_set(klass, extn->base_id +
1039 extn->desc->ops.count, _eo_class_isa_func);
1042 _dich_func_set(klass, klass->base_id + klass->desc->ops.count,
1043 _eo_class_isa_func);
1047 _dich_func_set(klass,
1048 klass->parent->base_id + klass->parent->desc->ops.count,
1049 _eo_class_isa_func);
1053 _eo_class_constructor(klass);
1060 eo_class_free(klass);
1065 eo_isa(const Eo *obj, const Eo_Class *klass)
1067 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
1068 EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, EINA_FALSE);
1069 const op_type_funcs *func = _dich_func_get(obj->klass,
1070 klass->base_id + klass->desc->ops.count);
1072 /* Currently implemented by reusing the LAST op id. Just marking it with
1073 * _eo_class_isa_func. */
1074 return (func && (func->func == _eo_class_isa_func));
1078 eo_parent_set(Eo *obj, const Eo *parent)
1080 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, EINA_FALSE);
1082 EO_MAGIC_RETURN_VAL(parent, EO_EINA_MAGIC, EINA_FALSE);
1084 if (obj->parent == parent)
1089 if (eo_composite_is(obj))
1091 eo_composite_detach(obj, obj->parent);
1096 obj->parent->children =
1097 eina_inlist_remove(obj->parent->children, EINA_INLIST_GET(obj));
1098 eo_xunref(obj, obj->parent);
1101 obj->parent = (Eo *) parent;
1104 obj->parent->children =
1105 eina_inlist_append(obj->parent->children, EINA_INLIST_GET(obj));
1106 eo_xref(obj, obj->parent);
1115 eo_add(const Eo_Class *klass, Eo *parent)
1118 EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, NULL);
1120 if (parent) EO_MAGIC_RETURN_VAL(parent, EO_EINA_MAGIC, NULL);
1122 if (EINA_UNLIKELY(klass->desc->type != EO_CLASS_TYPE_REGULAR))
1124 ERR("Class '%s' is not instantiate-able. Aborting.", klass->desc->name);
1128 Eo *obj = calloc(1, EO_ALIGN_SIZE(sizeof(*obj)) +
1129 (klass->data_offset + EO_ALIGN_SIZE(klass->desc->data_size)) +
1130 klass->extn_data_size);
1131 EINA_MAGIC_SET(obj, EO_EINA_MAGIC);
1135 eo_parent_set(obj, parent);
1137 _eo_condtor_reset(obj);
1140 do_err = !eo_do(obj, eo_constructor());
1142 if (EINA_UNLIKELY(do_err))
1144 ERR("Object of class '%s' - One of the object constructors have failed.", klass->desc->name);
1148 if (!obj->condtor_done)
1150 ERR("Object of class '%s' - Not all of the object constructors have been executed.", klass->desc->name);
1158 /* Unref twice, once for the ref above, and once for the basic object ref. */
1173 eo_xref_internal(Eo *obj, const Eo *ref_obj, const char *file, int line)
1175 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, obj);
1180 Eo_Xref_Node *xref = calloc(1, sizeof(*xref));
1181 xref->ref_obj = ref_obj;
1185 obj->xrefs = eina_inlist_prepend(obj->xrefs, EINA_INLIST_GET(xref));
1196 eo_xunref(Eo *obj, const Eo *ref_obj)
1198 EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
1200 Eo_Xref_Node *xref = NULL;
1201 EINA_INLIST_FOREACH(obj->xrefs, xref)
1203 if (xref->ref_obj == ref_obj)
1209 obj->xrefs = eina_inlist_remove(obj->xrefs, EINA_INLIST_GET(xref));
1214 ERR("ref_obj (%p) does not reference obj (%p). Aborting unref.", ref_obj, obj);
1231 eo_ref(const Eo *_obj)
1233 Eo *obj = (Eo *) _obj;
1234 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, obj);
1236 return _eo_ref(obj);
1240 _eo_del_internal(Eo *obj)
1243 /* We need that for the event callbacks that may ref/unref. */
1246 eo_do(obj, eo_event_callback_call(EO_EV_DEL, NULL, NULL));
1248 const Eo_Class *klass = eo_class_get(obj);
1250 _eo_condtor_reset(obj);
1252 do_err = eo_do(obj, eo_destructor());
1253 if (EINA_UNLIKELY(!do_err))
1255 ERR("Object of class '%s' - One of the object destructors have failed.", klass->desc->name);
1258 if (!obj->condtor_done)
1260 ERR("Object of class '%s' - Not all of the object destructors have been executed.", klass->desc->name);
1262 /*FIXME: add eo_class_unref(klass) ? - just to clear the caches. */
1265 Eina_List *itr, *itr_n;
1267 EINA_LIST_FOREACH_SAFE(obj->composite_objects, itr, itr_n, emb_obj)
1269 eo_composite_detach(emb_obj, obj);
1273 while (obj->children)
1275 eo_parent_set(EINA_INLIST_CONTAINER_GET(obj->children, Eo), NULL);
1278 obj->del = EINA_TRUE;
1285 EINA_MAGIC_SET(obj, EO_FREED_EINA_MAGIC);
1292 if (--(obj->refcount) == 0)
1296 ERR("Object %p already deleted.", obj);
1300 _eo_del_internal(obj);
1303 /* If for some reason it's not empty, clear it. */
1306 WRN("obj->xrefs is not empty, possibly a bug, please report. - An error will be reported for each xref in the stack.");
1307 Eina_Inlist *nitr = obj->xrefs->next;
1308 free(EINA_INLIST_CONTAINER_GET(obj->xrefs, Eo_Xref_Node));
1313 if (!obj->manual_free)
1316 _eo_ref(obj); /* If we manual free, we keep a phantom ref. */
1321 eo_unref(const Eo *_obj)
1323 Eo *obj = (Eo *) _obj;
1324 EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
1330 eo_del(const Eo *obj)
1332 eo_parent_set((Eo *) obj, NULL);
1337 eo_ref_get(const Eo *obj)
1339 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, 0);
1341 return obj->refcount;
1345 eo_parent_get(const Eo *obj)
1347 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, NULL);
1353 eo_error_set_internal(const Eo *obj, const char *file, int line)
1355 EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
1357 ERR("Error with obj '%p' at %s:%d", obj, file, line);
1359 ((Eo *) obj)->do_error = EINA_TRUE;
1363 _eo_condtor_done(Eo *obj)
1365 if (obj->condtor_done)
1367 ERR("Object %p is already constructed at this point.", obj);
1371 obj->condtor_done = EINA_TRUE;
1375 _eo_condtor_reset(Eo *obj)
1377 obj->condtor_done = EINA_FALSE;
1380 static inline void *
1381 _eo_data_get(const Eo *obj, const Eo_Class *klass)
1383 if (EINA_LIKELY(klass->desc->data_size > 0))
1385 if (EINA_UNLIKELY(klass->desc->type == EO_CLASS_TYPE_MIXIN))
1387 Eo_Extension_Data_Offset *doff_itr =
1388 eo_class_get(obj)->extn_data_off;
1393 while (doff_itr->klass)
1395 if (doff_itr->klass == klass)
1396 return ((char *) obj) + EO_ALIGN_SIZE(sizeof(*obj)) +
1403 return ((char *) obj) + EO_ALIGN_SIZE(sizeof(*obj)) +
1412 eo_data_get(const Eo *obj, const Eo_Class *klass)
1415 EO_MAGIC_RETURN_VAL(obj, EO_EINA_MAGIC, NULL);
1416 EO_MAGIC_RETURN_VAL(klass, EO_CLASS_EINA_MAGIC, NULL);
1419 if (!_eo_class_mro_has(obj->klass, klass))
1421 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);
1426 ret = _eo_data_get(obj, klass);
1429 if (!ret && (klass->desc->data_size == 0))
1431 ERR("Tried getting data of class '%s', but it has none..", klass->desc->name);
1441 const char *log_dom = "eo";
1442 if (_eo_init_count++ > 0)
1448 _eo_classes_last_id = EO_STATIC_IDS_LAST;
1449 _eo_ops_last_id = EO_OP_IDS_FIRST;
1450 _eo_log_dom = eina_log_domain_register(log_dom, EINA_COLOR_LIGHTBLUE);
1451 if (_eo_log_dom < 0)
1453 EINA_LOG_ERR("Could not register log domain: %s", log_dom);
1457 if (!eina_lock_new(&_eo_class_creation_lock))
1459 EINA_LOG_ERR("Could not init lock.");
1463 eina_magic_string_static_set(EO_EINA_MAGIC, EO_EINA_MAGIC_STR);
1464 eina_magic_string_static_set(EO_FREED_EINA_MAGIC,
1465 EO_FREED_EINA_MAGIC_STR);
1466 eina_magic_string_static_set(EO_CLASS_EINA_MAGIC,
1467 EO_CLASS_EINA_MAGIC_STR);
1470 /* Call it just for coverage purposes. Ugly I know, but I like it better than
1471 * casting everywhere else. */
1472 _eo_class_isa_func(NULL, NULL, NULL);
1482 Eo_Class **cls_itr = _eo_classes;
1484 if (--_eo_init_count > 0)
1487 for (i = 0 ; i < _eo_classes_last_id ; i++, cls_itr++)
1490 eo_class_free(*cls_itr);
1496 eina_lock_free(&_eo_class_creation_lock);
1498 eina_log_domain_unregister(_eo_log_dom);
1506 eo_composite_attach(Eo *comp_obj, Eo *parent)
1508 EO_MAGIC_RETURN(comp_obj, EO_EINA_MAGIC);
1509 EO_MAGIC_RETURN(parent, EO_EINA_MAGIC);
1511 comp_obj->composite = EINA_TRUE;
1512 eo_parent_set(comp_obj, parent);
1513 parent->composite_objects = eina_list_prepend(parent->composite_objects, comp_obj);
1517 eo_composite_detach(Eo *comp_obj, Eo *parent)
1519 EO_MAGIC_RETURN(comp_obj, EO_EINA_MAGIC);
1520 EO_MAGIC_RETURN(parent, EO_EINA_MAGIC);
1522 comp_obj->composite = EINA_FALSE;
1523 parent->composite_objects = eina_list_remove(parent->composite_objects, comp_obj);
1524 eo_parent_set(comp_obj, NULL);
1528 eo_composite_is(const Eo *comp_obj)
1530 if (!EINA_MAGIC_CHECK(comp_obj, EO_EINA_MAGIC))
1532 EINA_MAGIC_FAIL(comp_obj, EO_EINA_MAGIC);
1536 return comp_obj->composite;
1540 eo_manual_free_set(Eo *obj, Eina_Bool manual_free)
1542 EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
1543 obj->manual_free = manual_free;
1547 eo_manual_free(Eo *obj)
1549 EO_MAGIC_RETURN(obj, EO_EINA_MAGIC);
1551 if (EINA_FALSE == obj->manual_free)
1553 ERR("Tried to manually free the object %p while the option has not been set; see eo_manual_free_set for more information.", obj);
1559 ERR("Tried deleting the object %p while still referenced(%d).", obj, eo_ref_get(obj));