6 static int _eobj_log_dom = -1;
8 static Eobj_Class **classes;
9 static Eobj_Class_Id classes_last_id;
10 static Eina_Bool _eobj_init_count = 0;
12 #define CONSTRUCT_ERROR_KEY "__construct_error"
14 static void _eobj_callback_remove_all(Eobj *obj);
15 static void _eobj_generic_data_del_all(Eobj *obj);
16 static void eobj_class_constructor(Eobj *obj, const Eobj_Class *klass);
17 static void eobj_class_destructor(Eobj *obj, const Eobj_Class *klass);
22 #define CRITICAL(...) EINA_LOG_DOM_CRIT(_eobj_log_dom, __VA_ARGS__)
27 #define ERR(...) EINA_LOG_DOM_ERR(_eobj_log_dom, __VA_ARGS__)
32 #define WRN(...) EINA_LOG_DOM_WARN(_eobj_log_dom, __VA_ARGS__)
37 #define INF(...) EINA_LOG_DOM_INFO(_eobj_log_dom, __VA_ARGS__)
42 #define DBG(...) EINA_LOG_DOM_DBG(_eobj_log_dom, __VA_ARGS__)
44 typedef struct _Eobj_Callback_Description Eobj_Callback_Description;
48 const Eobj_Class *klass;
52 Eina_List *composite_objects;
54 Eina_Inlist *callbacks;
57 Eina_Inlist *generic_data;
59 const Eobj_Class *kls_itr;
66 /* Dich search, split to 0xff 0xff 0xffff */
68 #define DICH_CHAIN1_MASK (0xff)
69 #define DICH_CHAIN2_MASK (0xff)
70 #define DICH_CHAIN_LAST_MASK (0xffff)
71 #define DICH_CHAIN1_SIZE (DICH_CHAIN1_MASK + 1)
72 #define DICH_CHAIN2_SIZE (DICH_CHAIN2_MASK + 1)
73 #define DICH_CHAIN_LAST_SIZE (DICH_CHAIN_LAST_MASK + 1)
74 #define DICH_CHAIN1(x) (((x) >> 24) & DICH_CHAIN1_MASK)
75 #define DICH_CHAIN2(x) (((x) >> 16) & DICH_CHAIN2_MASK)
76 #define DICH_CHAIN_LAST(x) ((x) & DICH_CHAIN_LAST_MASK)
78 #define OP_CLASS_OFFSET 16
79 #define OP_CLASS_OFFSET_GET(x) (((x) >> OP_CLASS_OFFSET) & 0xffff)
80 #define OP_CLASS_GET(op) ({ \
81 Eobj_Class_Id tmp = OP_CLASS_OFFSET_GET(op); \
82 (Eobj_Class *) ((tmp <= classes_last_id) && (tmp > 0)) ? \
83 (classes[tmp - 1]) : NULL; \
86 /* Structure of Eobj_Op is:
91 typedef struct _Dich_Chain1 Dich_Chain1;
95 eobj_op_func_type func;
100 op_type_funcs *funcs;
110 const Eobj_Class *klass;
111 Eina_Bool exists : 1; /* < True if already exists in class (incl parents). */
112 } Eobj_Extension_Node;
116 Eobj_Class_Id class_id;
117 const Eobj_Class *parent;
118 const Eobj_Class_Description *desc;
119 Dich_Chain1 chain[DICH_CHAIN1_SIZE];
120 Eina_Inlist *extensions;
121 Eina_Bool constructed : 1;
124 static inline eobj_op_func_type
125 dich_func_get(const Eobj_Class *klass, Eobj_Op op)
127 const Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
128 if (!chain1) return NULL;
129 if (!chain1->chain) return NULL;
130 Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
131 if (!chain2) return NULL;
132 if (!chain2->funcs) return NULL;
134 /* num_ops is calculated from the class. */
135 const Eobj_Class *op_klass = OP_CLASS_GET(op);
136 if (!op_klass || (DICH_CHAIN_LAST(op) >= op_klass->desc->ops.count))
139 return chain2->funcs[DICH_CHAIN_LAST(op)].func;
143 dich_func_set(Eobj_Class *klass, Eobj_Op op, eobj_op_func_type func)
145 const Eobj_Class *op_klass = OP_CLASS_GET(op);
148 /* Verify op is valid. */
151 /* num_ops is calculated from the class. */
152 num_ops = op_klass->desc->ops.count;
153 if (DICH_CHAIN_LAST(op) >= num_ops)
155 ERR("OP %x is too big for the domain '%s', expected value < %x.",
156 op, op_klass->desc->name, op_klass->desc->ops.count);
161 ERR("OP %x is from an illegal class.", op);
165 Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
168 klass->chain[DICH_CHAIN1(op)].chain =
170 calloc(DICH_CHAIN2_SIZE, sizeof(*(chain1->chain)));
173 Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
176 chain2->funcs = chain1->chain[DICH_CHAIN2(op)].funcs =
177 calloc(num_ops, sizeof(*(chain2->funcs)));
180 chain2->funcs[DICH_CHAIN_LAST(op)].func = func;
184 dich_func_clean_all(Eobj_Class *klass)
187 Dich_Chain1 *chain1 = klass->chain;
189 for (i = 0 ; i < DICH_CHAIN1_SIZE ; i++, chain1++)
192 Dich_Chain2 *chain2 = chain1->chain;
197 for (j = 0 ; j < DICH_CHAIN2_SIZE ; j++, chain2++)
202 chain1->chain = NULL;
208 /* FIXME: Decide if it should be fast, and if so, add a mapping.
209 * Otherwise, this is very slow. But since it's only for debugging... */
210 static const Eobj_Op_Description *
211 _eobj_op_id_desc_get(Eobj_Op op)
214 Eobj_Class **cls_itr = classes;
216 for (i = 0 ; i < classes_last_id ; i++, cls_itr++)
220 const Eobj_Op_Description *desc = (*cls_itr)->desc->ops.descs;
224 Eobj_Op base_op_id = *(*cls_itr)->desc->ops.base_op_id;
227 if ((base_op_id + desc->sub_op) == op)
238 _eobj_op_internal(Eobj *obj, const Eobj_Class *obj_klass, Eobj_Op op, va_list *p_list)
240 const Eobj_Class *klass = obj_klass;
241 eobj_op_func_type func;
248 func = dich_func_get(klass, op);
252 func(obj, op, p_list);
257 klass = klass->parent;
264 /* FIXME: Should probably flatten everything. to be faster. */
267 Eobj_Extension_Node *itr;
268 EINA_INLIST_FOREACH(klass->extensions, itr)
270 if (_eobj_op_internal(obj, itr->klass, op, p_list))
277 /* Try composite objects */
281 EINA_LIST_FOREACH(obj->composite_objects, itr, emb_obj)
283 if (_eobj_op_internal(emb_obj, eobj_class_get(emb_obj), op, p_list))
290 /* If haven't found anything, return FALSE */
297 static inline Eina_Bool
298 _eobj_ops_internal(Eobj *obj, const Eobj_Class *obj_klass, va_list *p_list)
300 Eina_Bool ret = EINA_TRUE;
303 op = va_arg(*p_list, Eobj_Op);
306 if (!_eobj_op_internal(obj, obj_klass, op, p_list))
308 const Eobj_Op_Description *desc = _eobj_op_id_desc_get(op);
309 const char *_id_name = (desc) ? desc->name : NULL;
310 const Eobj_Class *op_klass = OP_CLASS_GET(op);
311 const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL;
312 ERR("Can't find func for op %x ('%s' of domain '%s') for class '%s'. Aborting.",
313 op, _id_name, _dom_name,
314 obj_klass->desc->name);
318 op = va_arg(*p_list, Eobj_Op);
327 eobj_do_internal(Eobj *obj, ...)
331 va_start(p_list, obj);
332 ret = _eobj_ops_internal(obj, eobj_class_get(obj), &p_list);
338 eobj_class_do_internal(Eobj *obj, const Eobj_Class *klass, ...)
342 va_start(p_list, klass);
343 ret = _eobj_ops_internal(obj, klass, &p_list);
348 EAPI const Eobj_Class *
349 eobj_class_get(Eobj *obj)
354 EAPI const Eobj_Class *
355 eobj_class_parent_get(const Eobj_Class *klass)
357 return klass->parent;
361 eobj_class_name_get(const Eobj_Class *klass)
363 return klass->desc->name;
367 _eobj_class_base_op_init(Eobj_Class *klass)
369 const Eobj_Class_Description *desc = klass->desc;
370 if (!desc || !desc->ops.base_op_id)
373 /* FIXME: Depends on values defined above! */
374 *(desc->ops.base_op_id) = klass->class_id << OP_CLASS_OFFSET;
378 _eobj_class_constructor(Eobj_Class *klass)
380 if (klass->constructed)
383 klass->constructed = EINA_TRUE;
385 if (!klass->desc->class_constructor)
388 klass->desc->class_constructor(klass);
392 eobj_class_funcs_set(Eobj_Class *klass, const Eobj_Op_Func_Description *func_descs)
394 const Eobj_Op_Func_Description *itr;
398 for ( ; itr->op != 0 ; itr++)
400 dich_func_set(klass, itr->op, itr->func);
406 _eobj_class_extn_exists(const Eobj_Class *klass, const Eobj_Class *extn_cls)
410 Eobj_Extension_Node *extn;
411 EINA_INLIST_FOREACH(klass->extensions, extn)
413 if (extn->klass == extn_cls)
417 klass = klass->parent;
424 eobj_class_new(const Eobj_Class_Description *desc, const Eobj_Class *parent, ...)
429 va_start(p_list, parent);
431 #define _CLS_NEW_CHECK(x) \
436 ERR("%s can't be NULL! Aborting.", #x); \
442 _CLS_NEW_CHECK(desc);
443 _CLS_NEW_CHECK(desc->name);
444 _CLS_NEW_CHECK(desc->constructor);
445 _CLS_NEW_CHECK(desc->destructor);
447 klass = calloc(1, sizeof(Eobj_Class));
448 klass->parent = parent;
449 klass->class_id = ++classes_last_id;
451 /* FIXME: Handle errors. */
453 tmp = realloc(classes, classes_last_id * sizeof(*classes));
455 classes[klass->class_id - 1] = klass;
458 /* Handle class extensions */
460 Eobj_Class *extn = NULL;
462 extn = va_arg(p_list, Eobj_Class *);
465 switch (extn->desc->type)
467 case EOBJ_CLASS_TYPE_REGULAR:
468 case EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT:
469 /* Use it like an interface. */
470 case EOBJ_CLASS_TYPE_INTERFACE:
472 case EOBJ_CLASS_TYPE_MIXIN:
474 Eobj_Extension_Node *node = calloc(1, sizeof(*node));
476 node->exists = _eobj_class_extn_exists(klass, extn);
478 eina_inlist_append(klass->extensions,
479 EINA_INLIST_GET(node));
484 extn = va_arg(p_list, Eobj_Class *);
489 _eobj_class_base_op_init(klass);
491 /* FIXME: Shouldn't be called here - should be called from eobj_add. */
492 _eobj_class_constructor(klass);
498 #undef _CLS_NEW_CHECK
501 eobj_class_free(Eobj_Class *klass)
503 if (klass->constructed)
505 if (klass->desc->class_destructor)
506 klass->desc->class_destructor(klass);
508 dich_func_clean_all(klass);
513 Eobj_Extension_Node *extn;
514 EINA_INLIST_FOREACH_SAFE(klass->extensions, itrn, extn)
524 _eobj_class_count_parents(const Eobj_Class *klass)
528 for (count = 0 ; klass->parent ; klass = klass->parent)
535 eobj_add(const Eobj_Class *klass, Eobj *parent)
537 if (klass->desc->type != EOBJ_CLASS_TYPE_REGULAR)
539 ERR("Class '%s' is not instantiate-able. Aborting.", klass->desc->name);
543 Eobj *obj = calloc(1, sizeof(*obj));
545 obj->parent = parent;
549 size_t datas_count = 0;
552 const Eobj_Class *kls_itr;
554 datas_count = _eobj_class_count_parents(klass) + 1;
556 obj->datas = calloc(datas_count, sizeof(*(obj->datas)));
558 /* Calculate all the offsets and set in the datas array. */
559 pvt_itr = obj->datas + datas_count - 1;
560 for (kls_itr = klass ; kls_itr->parent ; kls_itr = kls_itr->parent)
562 *pvt_itr = (void *) offset;
564 /* FIXME: Make sure this alignment is enough. */
565 offset += kls_itr->desc->private_size +
567 (kls_itr->desc->private_size % sizeof(void *)));
571 /* Allocate the datas blob and update the offsets. */
572 obj->data_blob = calloc(1, offset);
574 pvt_itr = obj->datas;
575 for (i = 0 ; i < datas_count ; i++)
577 *pvt_itr = ((char *) obj->data_blob) + (intptr_t) *pvt_itr;
583 eobj_class_constructor(obj, klass);
584 if (obj->kls_itr && obj->kls_itr->parent)
586 ERR("Type '%s' - Not all of the object constructors have been executed.", klass->desc->name);
590 if (eobj_generic_data_get(obj, CONSTRUCT_ERROR_KEY))
592 ERR("Type '%s' - One of the object constructors have failed.", klass->desc->name);
611 eobj_unref(Eobj *obj)
613 if (--(obj->refcount) == 0)
615 const Eobj_Class *klass = eobj_class_get(obj);
616 eobj_class_destructor(obj, klass);
617 /*FIXME: add eobj_class_unref(klass) ? - just to clear the caches. */
619 Eina_List *itr, *itr_n;
621 EINA_LIST_FOREACH_SAFE(obj->composite_objects, itr, itr_n, emb_obj)
624 obj->composite_objects =
625 eina_list_remove_list(obj->composite_objects, itr);
628 _eobj_callback_remove_all(obj);
631 free(obj->data_blob);
634 _eobj_generic_data_del_all(obj);
643 obj->delete = EINA_TRUE;
648 eobj_parent_get(Eobj *obj)
654 eobj_constructor_error_set(Eobj *obj)
656 eobj_generic_data_set(obj, CONSTRUCT_ERROR_KEY, (void *) EINA_TRUE);
660 eobj_constructor_error_get(const Eobj *obj)
662 return (intptr_t) eobj_generic_data_get(obj, CONSTRUCT_ERROR_KEY);
666 eobj_class_constructor(Eobj *obj, const Eobj_Class *klass)
668 const Eobj_Extension_Node *extn;
670 obj->kls_itr = klass;
675 EINA_INLIST_FOREACH(klass->extensions, extn)
677 /* Only call if it's the first one in the class. */
678 if (!extn->exists && extn->klass->desc->constructor)
679 extn->klass->desc->constructor(obj);
682 klass->desc->constructor(obj);
686 eobj_class_destructor(Eobj *obj, const Eobj_Class *klass)
688 const Eobj_Extension_Node *extn;
690 obj->kls_itr = klass;
695 klass->desc->destructor(obj);
697 EINA_INLIST_REVERSE_FOREACH(klass->extensions, extn)
699 /* Only call if it's the first one in the class. */
700 if (!extn->exists && extn->klass->desc->destructor)
701 extn->klass->desc->destructor(obj);
707 eobj_constructor_super(Eobj *obj)
709 if (obj->kls_itr->parent)
710 eobj_class_constructor(obj, obj->kls_itr->parent);
714 eobj_destructor_super(Eobj *obj)
716 if (obj->kls_itr->parent)
717 eobj_class_destructor(obj, obj->kls_itr->parent);
721 eobj_data_get(Eobj *obj, const Eobj_Class *klass)
723 /* FIXME: Add a check that this is of the right klass and we don't seg.
724 * Probably just return NULL. */
725 return obj->datas[_eobj_class_count_parents(klass)];
731 Eina_Stringshare *key;
733 } Eobj_Generic_Data_Node;
736 _eobj_generic_data_node_free(Eobj_Generic_Data_Node *node)
738 eina_stringshare_del(node->key);
743 _eobj_generic_data_del_all(Eobj *obj)
746 Eobj_Generic_Data_Node *node;
748 EINA_INLIST_FOREACH_SAFE(obj->generic_data, nnode, node)
750 obj->generic_data = eina_inlist_remove(obj->generic_data,
751 EINA_INLIST_GET(node));
753 _eobj_generic_data_node_free(node);
758 eobj_generic_data_set(Eobj *obj, const char *key, const void *data)
761 Eobj_Generic_Data_Node *node;
763 if (!key) return NULL;
764 if (!data) return NULL;
766 prev_data = eobj_generic_data_del(obj, key);
768 node = malloc(sizeof(Eobj_Generic_Data_Node));
769 node->key = eina_stringshare_add(key);
770 node->data = (void *) data;
771 obj->generic_data = eina_inlist_prepend(obj->generic_data,
772 EINA_INLIST_GET(node));
778 eobj_generic_data_get(const Eobj *obj, const char *key)
780 Eobj_Generic_Data_Node *node;
782 if (!key) return NULL;
784 EINA_INLIST_FOREACH(obj->generic_data, node)
786 if (!strcmp(node->key, key))
788 ((Eobj *) obj)->generic_data =
789 eina_inlist_promote(obj->generic_data, EINA_INLIST_GET(node));
797 eobj_generic_data_del(Eobj *obj, const char *key)
799 Eobj_Generic_Data_Node *node;
801 if (!key) return NULL;
803 EINA_INLIST_FOREACH(obj->generic_data, node)
805 if (!strcmp(node->key, key))
810 obj->generic_data = eina_inlist_remove(obj->generic_data,
811 EINA_INLIST_GET(node));
812 _eobj_generic_data_node_free(node);
822 if (_eobj_init_count++ > 0)
829 _eobj_log_dom = eina_log_domain_register("eobj", EINA_COLOR_LIGHTBLUE);
830 if (_eobj_log_dom < 0)
832 EINA_LOG_ERR("Could not register log domain: eobj");
843 Eobj_Class **cls_itr = classes;
845 if (--_eobj_init_count > 0)
848 for (i = 0 ; i < classes_last_id ; i++, cls_itr++)
851 eobj_class_free(*cls_itr);
857 eina_log_domain_unregister(_eobj_log_dom);
865 eobj_composite_object_attach(Eobj *obj, Eobj *emb_obj)
868 obj->composite_objects = eina_list_prepend(obj->composite_objects, emb_obj);
872 eobj_composite_object_detach(Eobj *obj, Eobj *emb_obj)
874 obj->composite_objects = eina_list_remove(obj->composite_objects, emb_obj);
879 eobj_composite_is(Eobj *emb_obj)
881 Eobj *obj = eobj_parent_get(emb_obj);
884 EINA_LIST_FOREACH(obj->composite_objects, itr, tmp)
894 struct _Eobj_Callback_Description
897 const Eobj_Event_Description *event;
900 Eobj_Callback_Priority priority;
901 Eina_Bool delete_me : 1;
904 /* Actually remove, doesn't care about walking list, or delete_me */
906 _eobj_callback_remove(Eobj *obj, Eobj_Callback_Description *cb)
908 obj->callbacks = eina_inlist_remove(obj->callbacks,
909 EINA_INLIST_GET(cb));
913 /* Actually remove, doesn't care about walking list, or delete_me */
915 _eobj_callback_remove_all(Eobj *obj)
918 Eobj_Callback_Description *cb;
919 EINA_INLIST_FOREACH_SAFE(obj->callbacks, initr, cb)
921 _eobj_callback_remove(obj, cb);
926 _eobj_callbacks_clear(Eobj *obj)
929 Eobj_Callback_Description *cb;
931 /* Abort if we are currently walking the list. */
932 if (obj->walking_list > 0)
935 EINA_INLIST_FOREACH_SAFE(obj->callbacks, itn, cb)
939 _eobj_callback_remove(obj, cb);
945 _callback_priority_cmp(const void *_a, const void *_b)
947 const Eobj_Callback_Description *a, *b;
948 a = (const Eobj_Callback_Description *) _a;
949 b = (const Eobj_Callback_Description *) _b;
950 if (a->priority < b->priority)
957 eobj_event_callback_add(Eobj *obj,
958 const Eobj_Event_Description *desc,
962 return eobj_event_callback_priority_add(obj, desc,
963 EOBJ_CALLBACK_PRIORITY_DEFAULT, cb, data);
967 eobj_event_callback_priority_add(Eobj *obj,
968 const Eobj_Event_Description *desc,
969 Eobj_Callback_Priority priority,
973 Eobj_Callback_Description *cb = calloc(1, sizeof(*cb));
976 cb->func_data = (void *) data;
977 cb->priority = priority;
978 obj->callbacks = eina_inlist_sorted_insert(obj->callbacks,
979 EINA_INLIST_GET(cb), _callback_priority_cmp);
981 eobj_event_callback_call(obj, EOBJ_SIG_CALLBACK_ADD, desc);
987 eobj_event_callback_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func)
990 Eobj_Callback_Description *cb;
991 EINA_INLIST_FOREACH(obj->callbacks, cb)
993 if ((cb->event == desc) && (cb->func == func))
997 data = cb->func_data;
998 cb->delete_me = EINA_TRUE;
999 _eobj_callbacks_clear(obj);
1006 eobj_event_callback_call(obj, EOBJ_SIG_CALLBACK_DEL, desc);
1011 eobj_event_callback_del_full(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func, const void *user_data)
1014 Eobj_Callback_Description *cb;
1015 EINA_INLIST_FOREACH(obj->callbacks, cb)
1017 if ((cb->event == desc) && (cb->func == func) &&
1018 (cb->func_data == user_data))
1022 data = cb->func_data;
1023 cb->delete_me = EINA_TRUE;
1024 _eobj_callbacks_clear(obj);
1031 eobj_event_callback_call(obj, EOBJ_SIG_CALLBACK_DEL, desc);
1036 eobj_event_callback_call(Eobj *obj, const Eobj_Event_Description *desc,
1037 const void *event_info)
1039 Eobj_Callback_Description *cb;
1041 obj->walking_list++;
1043 EINA_INLIST_FOREACH(obj->callbacks, cb)
1045 if (!cb->delete_me && (cb->event == desc))
1047 /* Abort callback calling if the func says so. */
1048 if (!cb->func((void *) cb->func_data, obj, desc,
1049 (void *) event_info))
1057 obj->walking_list--;
1058 _eobj_callbacks_clear(obj);
1064 _eobj_event_forwarder_callback(void *data, Eobj *obj, const Eobj_Event_Description *desc, void *event_info)
1067 Eobj *new_obj = (Eobj *) data;
1068 return eobj_event_callback_call(new_obj, desc, event_info);
1071 /* FIXME: Change default priority? Maybe call later? */
1073 eobj_event_callback_forwarder_add(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj)
1075 return eobj_event_callback_add(obj, desc, _eobj_event_forwarder_callback, new_obj);
1079 eobj_event_callback_forwarder_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj)
1081 eobj_event_callback_del_full(obj, desc, _eobj_event_forwarder_callback, new_obj);
1085 /* EOBJ_CLASS_BASE stuff */
1086 static Eobj_Class *_my_class = NULL;
1088 /* FIXME: Set proper type descriptions. */
1089 EAPI const Eobj_Event_Description _EOBJ_SIG_CALLBACK_ADD =
1090 EOBJ_EVENT_DESCRIPTION("callback,add", "?", "Called when a callback was added.");
1091 EAPI const Eobj_Event_Description _EOBJ_SIG_CALLBACK_DEL =
1092 EOBJ_EVENT_DESCRIPTION("callback,del", "?", "Called when a callback was deleted.");
1095 _constructor(Eobj *obj)
1097 DBG("%p - %s.", obj, _my_class->desc->name);
1101 _destructor(Eobj *obj)
1103 DBG("%p - %s.", obj, _my_class->desc->name);
1106 EAPI const Eobj_Class *
1107 eobj_base_class_get(void)
1109 if (_my_class) return _my_class;
1111 static const Eobj_Class_Description class_desc = {
1113 EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT,
1114 EOBJ_CLASS_DESCRIPTION_OPS(NULL, NULL, 0),
1123 return _my_class = eobj_class_new(&class_desc, NULL, NULL);