5 static int _eobj_log_dom = -1;
7 static Eobj_Class **classes;
8 static Eobj_Class_Id classes_last_id;
9 static Eina_Bool _eobj_init_count = 0;
11 #define CONSTRUCT_ERROR_KEY "__construct_error"
13 static void _eobj_callback_remove_all(Eobj *obj);
14 static void _eobj_generic_data_del_all(Eobj *obj);
15 static void eobj_class_constructor(Eobj *obj, const Eobj_Class *klass);
16 static void eobj_class_destructor(Eobj *obj, const Eobj_Class *klass);
21 #define CRITICAL(...) EINA_LOG_DOM_CRIT(_eobj_log_dom, __VA_ARGS__)
26 #define ERR(...) EINA_LOG_DOM_ERR(_eobj_log_dom, __VA_ARGS__)
31 #define WRN(...) EINA_LOG_DOM_WARN(_eobj_log_dom, __VA_ARGS__)
36 #define INF(...) EINA_LOG_DOM_INFO(_eobj_log_dom, __VA_ARGS__)
41 #define DBG(...) EINA_LOG_DOM_DBG(_eobj_log_dom, __VA_ARGS__)
43 typedef struct _Eobj_Callback_Description Eobj_Callback_Description;
47 const Eobj_Class *klass;
51 Eina_List *composite_objects;
53 Eina_Inlist *callbacks;
56 Eina_Inlist *generic_data;
58 const Eobj_Class *kls_itr;
65 /* Dich search, split to 0xff 0xff 0xffff */
67 #define DICH_CHAIN1_MASK (0xff)
68 #define DICH_CHAIN2_MASK (0xff)
69 #define DICH_CHAIN_LAST_MASK (0xffff)
70 #define DICH_CHAIN1_SIZE (DICH_CHAIN1_MASK + 1)
71 #define DICH_CHAIN2_SIZE (DICH_CHAIN2_MASK + 1)
72 #define DICH_CHAIN_LAST_SIZE (DICH_CHAIN_LAST_MASK + 1)
73 #define DICH_CHAIN1(x) (((x) >> 24) & DICH_CHAIN1_MASK)
74 #define DICH_CHAIN2(x) (((x) >> 16) & DICH_CHAIN2_MASK)
75 #define DICH_CHAIN_LAST(x) ((x) & DICH_CHAIN_LAST_MASK)
77 #define OP_CLASS_OFFSET 16
78 #define OP_CLASS_OFFSET_GET(x) (((x) >> OP_CLASS_OFFSET) & 0xffff)
79 #define OP_CLASS_GET(op) ({ \
80 Eobj_Class_Id tmp = OP_CLASS_OFFSET_GET(op); \
81 (Eobj_Class *) ((tmp <= classes_last_id) && (tmp > 0)) ? \
82 (classes[tmp - 1]) : NULL; \
85 /* Structure of Eobj_Op is:
90 typedef struct _Dich_Chain1 Dich_Chain1;
94 eobj_op_func_type func;
109 const Eobj_Class *klass;
110 Eina_Bool exists : 1; /* < True if already exists in class (incl parents). */
111 } Eobj_Extension_Node;
115 Eobj_Class_Id class_id;
116 const Eobj_Class *parent;
117 const Eobj_Class_Description *desc;
118 Dich_Chain1 chain[DICH_CHAIN1_SIZE];
119 Eina_Inlist *extensions;
120 Eina_Bool constructed : 1;
123 static inline eobj_op_func_type
124 dich_func_get(const Eobj_Class *klass, Eobj_Op op)
126 const Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
127 if (!chain1) return NULL;
128 if (!chain1->chain) return NULL;
129 Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
130 if (!chain2) return NULL;
131 if (!chain2->funcs) return NULL;
133 /* num_ops is calculated from the class. */
134 const Eobj_Class *op_klass = OP_CLASS_GET(op);
135 if (!op_klass || (DICH_CHAIN_LAST(op) >= op_klass->desc->ops.count))
138 return chain2->funcs[DICH_CHAIN_LAST(op)].func;
142 dich_func_set(Eobj_Class *klass, Eobj_Op op, eobj_op_func_type func)
144 const Eobj_Class *op_klass = OP_CLASS_GET(op);
147 /* Verify op is valid. */
150 /* num_ops is calculated from the class. */
151 num_ops = op_klass->desc->ops.count;
152 if (DICH_CHAIN_LAST(op) >= num_ops)
154 ERR("OP %x is too big for the domain '%s', expected value < %x.",
155 op, op_klass->desc->name, op_klass->desc->ops.count);
160 ERR("OP %x is from an illegal class.", op);
164 Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
167 klass->chain[DICH_CHAIN1(op)].chain =
169 calloc(DICH_CHAIN2_SIZE, sizeof(*(chain1->chain)));
172 Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
175 chain2->funcs = chain1->chain[DICH_CHAIN2(op)].funcs =
176 calloc(num_ops, sizeof(*(chain2->funcs)));
179 chain2->funcs[DICH_CHAIN_LAST(op)].func = func;
183 dich_func_clean_all(Eobj_Class *klass)
186 Dich_Chain1 *chain1 = klass->chain;
188 for (i = 0 ; i < DICH_CHAIN1_SIZE ; i++, chain1++)
191 Dich_Chain2 *chain2 = chain1->chain;
196 for (j = 0 ; j < DICH_CHAIN2_SIZE ; j++, chain2++)
201 chain1->chain = NULL;
207 /* FIXME: Decide if it should be fast, and if so, add a mapping.
208 * Otherwise, this is very slow. But since it's only for debugging... */
209 static const Eobj_Op_Description *
210 _eobj_op_id_desc_get(Eobj_Op op)
213 Eobj_Class **cls_itr = classes;
215 for (i = 0 ; i < classes_last_id ; i++, cls_itr++)
219 const Eobj_Op_Description *desc = (*cls_itr)->desc->ops.descs;
223 Eobj_Op base_op_id = *(*cls_itr)->desc->ops.base_op_id;
226 if ((base_op_id + desc->sub_op) == op)
237 _eobj_op_internal(Eobj *obj, const Eobj_Class *obj_klass, Eobj_Op op, va_list *p_list)
239 const Eobj_Class *klass = obj_klass;
240 eobj_op_func_type func;
247 func = dich_func_get(klass, op);
251 func(obj, op, p_list);
256 klass = klass->parent;
263 /* FIXME: Should probably flatten everything. to be faster. */
266 Eobj_Extension_Node *itr;
267 EINA_INLIST_FOREACH(klass->extensions, itr)
269 if (_eobj_op_internal(obj, itr->klass, op, p_list))
276 /* Try composite objects */
280 EINA_LIST_FOREACH(obj->composite_objects, itr, emb_obj)
282 if (_eobj_op_internal(emb_obj, eobj_class_get(emb_obj), op, p_list))
289 /* If haven't found anything, return FALSE */
296 static inline Eina_Bool
297 _eobj_ops_internal(Eobj *obj, const Eobj_Class *obj_klass, va_list *p_list)
299 Eina_Bool ret = EINA_TRUE;
302 op = va_arg(*p_list, Eobj_Op);
305 if (!_eobj_op_internal(obj, obj_klass, op, p_list))
307 const Eobj_Op_Description *desc = _eobj_op_id_desc_get(op);
308 const char *_id_name = (desc) ? desc->name : NULL;
309 const Eobj_Class *op_klass = OP_CLASS_GET(op);
310 const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL;
311 ERR("Can't find func for op %x ('%s' of domain '%s') for class '%s'. Aborting.",
312 op, _id_name, _dom_name,
313 obj_klass->desc->name);
317 op = va_arg(*p_list, Eobj_Op);
326 eobj_do_internal(Eobj *obj, ...)
330 va_start(p_list, obj);
331 ret = _eobj_ops_internal(obj, eobj_class_get(obj), &p_list);
337 eobj_class_do_internal(Eobj *obj, const Eobj_Class *klass, ...)
341 va_start(p_list, klass);
342 ret = _eobj_ops_internal(obj, klass, &p_list);
347 EAPI const Eobj_Class *
348 eobj_class_get(Eobj *obj)
353 EAPI const Eobj_Class *
354 eobj_class_parent_get(const Eobj_Class *klass)
356 return klass->parent;
360 eobj_class_name_get(const Eobj_Class *klass)
362 return klass->desc->name;
366 _eobj_class_base_op_init(Eobj_Class *klass)
368 const Eobj_Class_Description *desc = klass->desc;
369 if (!desc || !desc->ops.base_op_id)
372 /* FIXME: Depends on values defined above! */
373 *(desc->ops.base_op_id) = klass->class_id << OP_CLASS_OFFSET;
377 _eobj_class_constructor(Eobj_Class *klass)
379 if (klass->constructed)
382 klass->constructed = EINA_TRUE;
384 if (!klass->desc->class_constructor)
387 klass->desc->class_constructor(klass);
391 eobj_class_funcs_set(Eobj_Class *klass, const Eobj_Op_Func_Description *func_descs)
393 const Eobj_Op_Func_Description *itr;
397 for ( ; itr->op != 0 ; itr++)
399 dich_func_set(klass, itr->op, itr->func);
405 _eobj_class_extn_exists(const Eobj_Class *klass, const Eobj_Class *extn_cls)
409 Eobj_Extension_Node *extn;
410 EINA_INLIST_FOREACH(klass->extensions, extn)
412 if (extn->klass == extn_cls)
416 klass = klass->parent;
423 eobj_class_new(const Eobj_Class_Description *desc, const Eobj_Class *parent, ...)
428 va_start(p_list, parent);
430 #define _CLS_NEW_CHECK(x) \
435 ERR("%s can't be NULL! Aborting.", #x); \
441 _CLS_NEW_CHECK(desc);
442 _CLS_NEW_CHECK(desc->name);
443 _CLS_NEW_CHECK(desc->constructor);
444 _CLS_NEW_CHECK(desc->destructor);
446 klass = calloc(1, sizeof(Eobj_Class));
447 klass->parent = parent;
448 klass->class_id = ++classes_last_id;
450 /* FIXME: Handle errors. */
452 tmp = realloc(classes, classes_last_id * sizeof(*classes));
454 classes[klass->class_id - 1] = klass;
457 /* Handle class extensions */
459 Eobj_Class *extn = NULL;
461 extn = va_arg(p_list, Eobj_Class *);
464 switch (extn->desc->type)
466 case EOBJ_CLASS_TYPE_REGULAR:
467 case EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT:
468 /* Use it like an interface. */
469 case EOBJ_CLASS_TYPE_INTERFACE:
471 case EOBJ_CLASS_TYPE_MIXIN:
473 Eobj_Extension_Node *node = calloc(1, sizeof(*node));
475 node->exists = _eobj_class_extn_exists(klass, extn);
477 eina_inlist_append(klass->extensions,
478 EINA_INLIST_GET(node));
483 extn = va_arg(p_list, Eobj_Class *);
488 _eobj_class_base_op_init(klass);
490 /* FIXME: Shouldn't be called here - should be called from eobj_add. */
491 _eobj_class_constructor(klass);
497 #undef _CLS_NEW_CHECK
500 eobj_class_free(Eobj_Class *klass)
502 if (klass->constructed)
504 if (klass->desc->class_destructor)
505 klass->desc->class_destructor(klass);
507 dich_func_clean_all(klass);
512 Eobj_Extension_Node *extn;
513 EINA_INLIST_FOREACH_SAFE(klass->extensions, itrn, extn)
523 _eobj_class_count_parents(const Eobj_Class *klass)
527 for (count = 0 ; klass->parent ; klass = klass->parent)
534 eobj_add(const Eobj_Class *klass, Eobj *parent)
536 if (klass->desc->type != EOBJ_CLASS_TYPE_REGULAR)
538 ERR("Class '%s' is not instantiate-able. Aborting.", klass->desc->name);
542 Eobj *obj = calloc(1, sizeof(*obj));
544 obj->parent = parent;
548 size_t datas_count = 0;
551 const Eobj_Class *kls_itr;
553 datas_count = _eobj_class_count_parents(klass) + 1;
555 obj->datas = calloc(datas_count, sizeof(*(obj->datas)));
557 /* Calculate all the offsets and set in the datas array. */
558 pvt_itr = obj->datas + datas_count - 1;
559 for (kls_itr = klass ; kls_itr->parent ; kls_itr = kls_itr->parent)
561 *pvt_itr = (void *) offset;
563 /* FIXME: Make sure this alignment is enough. */
564 offset += kls_itr->desc->private_size +
566 (kls_itr->desc->private_size % sizeof(void *)));
570 /* Allocate the datas blob and update the offsets. */
571 obj->data_blob = calloc(1, offset);
573 pvt_itr = obj->datas;
574 for (i = 0 ; i < datas_count ; i++)
576 *pvt_itr = ((char *) obj->data_blob) + (intptr_t) *pvt_itr;
582 eobj_class_constructor(obj, klass);
583 if (obj->kls_itr && obj->kls_itr->parent)
585 ERR("Type '%s' - Not all of the object constructors have been executed.", klass->desc->name);
589 if (eobj_generic_data_get(obj, CONSTRUCT_ERROR_KEY))
591 ERR("Type '%s' - One of the object constructors have failed.", klass->desc->name);
610 eobj_unref(Eobj *obj)
612 if (--(obj->refcount) == 0)
614 const Eobj_Class *klass = eobj_class_get(obj);
615 eobj_class_destructor(obj, klass);
616 /*FIXME: add eobj_class_unref(klass) ? - just to clear the caches. */
618 Eina_List *itr, *itr_n;
620 EINA_LIST_FOREACH_SAFE(obj->composite_objects, itr, itr_n, emb_obj)
623 obj->composite_objects =
624 eina_list_remove_list(obj->composite_objects, itr);
627 _eobj_callback_remove_all(obj);
630 free(obj->data_blob);
633 _eobj_generic_data_del_all(obj);
642 obj->delete = EINA_TRUE;
647 eobj_parent_get(Eobj *obj)
653 eobj_constructor_error_set(Eobj *obj)
655 eobj_generic_data_set(obj, CONSTRUCT_ERROR_KEY, (void *) EINA_TRUE);
659 eobj_constructor_error_get(const Eobj *obj)
661 return (intptr_t) eobj_generic_data_get(obj, CONSTRUCT_ERROR_KEY);
665 eobj_class_constructor(Eobj *obj, const Eobj_Class *klass)
667 const Eobj_Extension_Node *extn;
669 obj->kls_itr = klass;
674 EINA_INLIST_FOREACH(klass->extensions, extn)
676 /* Only call if it's the first one in the class. */
677 if (!extn->exists && extn->klass->desc->constructor)
678 extn->klass->desc->constructor(obj);
681 klass->desc->constructor(obj);
685 eobj_class_destructor(Eobj *obj, const Eobj_Class *klass)
687 const Eobj_Extension_Node *extn;
689 obj->kls_itr = klass;
694 klass->desc->destructor(obj);
696 EINA_INLIST_REVERSE_FOREACH(klass->extensions, extn)
698 /* Only call if it's the first one in the class. */
699 if (!extn->exists && extn->klass->desc->destructor)
700 extn->klass->desc->destructor(obj);
706 eobj_constructor_super(Eobj *obj)
708 if (obj->kls_itr->parent)
709 eobj_class_constructor(obj, obj->kls_itr->parent);
713 eobj_destructor_super(Eobj *obj)
715 if (obj->kls_itr->parent)
716 eobj_class_destructor(obj, obj->kls_itr->parent);
720 eobj_data_get(Eobj *obj, const Eobj_Class *klass)
722 /* FIXME: Add a check that this is of the right klass and we don't seg.
723 * Probably just return NULL. */
724 return obj->datas[_eobj_class_count_parents(klass)];
730 Eina_Stringshare *key;
732 } Eobj_Generic_Data_Node;
735 _eobj_generic_data_node_free(Eobj_Generic_Data_Node *node)
737 eina_stringshare_del(node->key);
742 _eobj_generic_data_del_all(Eobj *obj)
745 Eobj_Generic_Data_Node *node;
747 EINA_INLIST_FOREACH_SAFE(obj->generic_data, nnode, node)
749 obj->generic_data = eina_inlist_remove(obj->generic_data,
750 EINA_INLIST_GET(node));
752 _eobj_generic_data_node_free(node);
757 eobj_generic_data_set(Eobj *obj, const char *key, const void *data)
760 Eobj_Generic_Data_Node *node;
762 if (!key) return NULL;
763 if (!data) return NULL;
765 prev_data = eobj_generic_data_del(obj, key);
767 node = malloc(sizeof(Eobj_Generic_Data_Node));
768 node->key = eina_stringshare_add(key);
769 node->data = (void *) data;
770 obj->generic_data = eina_inlist_prepend(obj->generic_data,
771 EINA_INLIST_GET(node));
777 eobj_generic_data_get(const Eobj *obj, const char *key)
779 Eobj_Generic_Data_Node *node;
781 if (!key) return NULL;
783 EINA_INLIST_FOREACH(obj->generic_data, node)
785 if (!strcmp(node->key, key))
787 ((Eobj *) obj)->generic_data =
788 eina_inlist_promote(obj->generic_data, EINA_INLIST_GET(node));
796 eobj_generic_data_del(Eobj *obj, const char *key)
798 Eobj_Generic_Data_Node *node;
800 if (!key) return NULL;
802 EINA_INLIST_FOREACH(obj->generic_data, node)
804 if (!strcmp(node->key, key))
809 obj->generic_data = eina_inlist_remove(obj->generic_data,
810 EINA_INLIST_GET(node));
811 _eobj_generic_data_node_free(node);
821 if (_eobj_init_count++ > 0)
828 _eobj_log_dom = eina_log_domain_register("eobj", EINA_COLOR_LIGHTBLUE);
829 if (_eobj_log_dom < 0)
831 EINA_LOG_ERR("Could not register log domain: eobj");
842 Eobj_Class **cls_itr = classes;
844 if (--_eobj_init_count > 0)
847 for (i = 0 ; i < classes_last_id ; i++, cls_itr++)
850 eobj_class_free(*cls_itr);
856 eina_log_domain_unregister(_eobj_log_dom);
864 eobj_composite_object_attach(Eobj *obj, Eobj *emb_obj)
867 obj->composite_objects = eina_list_prepend(obj->composite_objects, emb_obj);
871 eobj_composite_object_detach(Eobj *obj, Eobj *emb_obj)
873 obj->composite_objects = eina_list_remove(obj->composite_objects, emb_obj);
878 eobj_composite_is(Eobj *emb_obj)
880 Eobj *obj = eobj_parent_get(emb_obj);
883 EINA_LIST_FOREACH(obj->composite_objects, itr, tmp)
893 struct _Eobj_Callback_Description
896 const Eobj_Event_Description *event;
899 Eobj_Callback_Priority priority;
900 Eina_Bool delete_me : 1;
903 /* Actually remove, doesn't care about walking list, or delete_me */
905 _eobj_callback_remove(Eobj *obj, Eobj_Callback_Description *cb)
907 obj->callbacks = eina_inlist_remove(obj->callbacks,
908 EINA_INLIST_GET(cb));
912 /* Actually remove, doesn't care about walking list, or delete_me */
914 _eobj_callback_remove_all(Eobj *obj)
917 Eobj_Callback_Description *cb;
918 EINA_INLIST_FOREACH_SAFE(obj->callbacks, initr, cb)
920 _eobj_callback_remove(obj, cb);
925 _eobj_callbacks_clear(Eobj *obj)
928 Eobj_Callback_Description *cb;
930 /* Abort if we are currently walking the list. */
931 if (obj->walking_list > 0)
934 EINA_INLIST_FOREACH_SAFE(obj->callbacks, itn, cb)
938 _eobj_callback_remove(obj, cb);
944 _callback_priority_cmp(const void *_a, const void *_b)
946 const Eobj_Callback_Description *a, *b;
947 a = (const Eobj_Callback_Description *) _a;
948 b = (const Eobj_Callback_Description *) _b;
949 if (a->priority < b->priority)
956 eobj_event_callback_add(Eobj *obj,
957 const Eobj_Event_Description *desc,
961 return eobj_event_callback_priority_add(obj, desc,
962 EOBJ_CALLBACK_PRIORITY_DEFAULT, cb, data);
966 eobj_event_callback_priority_add(Eobj *obj,
967 const Eobj_Event_Description *desc,
968 Eobj_Callback_Priority priority,
972 Eobj_Callback_Description *cb = calloc(1, sizeof(*cb));
975 cb->func_data = (void *) data;
976 cb->priority = priority;
977 obj->callbacks = eina_inlist_sorted_insert(obj->callbacks,
978 EINA_INLIST_GET(cb), _callback_priority_cmp);
980 eobj_event_callback_call(obj, EOBJ_SIG_CALLBACK_ADD, desc);
986 eobj_event_callback_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func)
989 Eobj_Callback_Description *cb;
990 EINA_INLIST_FOREACH(obj->callbacks, cb)
992 if ((cb->event == desc) && (cb->func == func))
996 data = cb->func_data;
997 cb->delete_me = EINA_TRUE;
998 _eobj_callbacks_clear(obj);
1005 eobj_event_callback_call(obj, EOBJ_SIG_CALLBACK_DEL, desc);
1010 eobj_event_callback_del_full(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func, const void *user_data)
1013 Eobj_Callback_Description *cb;
1014 EINA_INLIST_FOREACH(obj->callbacks, cb)
1016 if ((cb->event == desc) && (cb->func == func) &&
1017 (cb->func_data == user_data))
1021 data = cb->func_data;
1022 cb->delete_me = EINA_TRUE;
1023 _eobj_callbacks_clear(obj);
1030 eobj_event_callback_call(obj, EOBJ_SIG_CALLBACK_DEL, desc);
1035 eobj_event_callback_call(Eobj *obj, const Eobj_Event_Description *desc,
1036 const void *event_info)
1038 Eobj_Callback_Description *cb;
1040 obj->walking_list++;
1042 EINA_INLIST_FOREACH(obj->callbacks, cb)
1044 if (!cb->delete_me && (cb->event == desc))
1046 /* Abort callback calling if the func says so. */
1047 if (!cb->func((void *) cb->func_data, obj, desc,
1048 (void *) event_info))
1056 obj->walking_list--;
1057 _eobj_callbacks_clear(obj);
1063 _eobj_event_forwarder_callback(void *data, Eobj *obj, const Eobj_Event_Description *desc, void *event_info)
1066 Eobj *new_obj = (Eobj *) data;
1067 return eobj_event_callback_call(new_obj, desc, event_info);
1070 /* FIXME: Change default priority? Maybe call later? */
1072 eobj_event_callback_forwarder_add(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj)
1074 return eobj_event_callback_add(obj, desc, _eobj_event_forwarder_callback, new_obj);
1078 eobj_event_callback_forwarder_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj)
1080 eobj_event_callback_del_full(obj, desc, _eobj_event_forwarder_callback, new_obj);
1084 /* EOBJ_CLASS_BASE stuff */
1085 static Eobj_Class *_my_class = NULL;
1087 /* FIXME: Set proper type descriptions. */
1088 EAPI const Eobj_Event_Description _EOBJ_SIG_CALLBACK_ADD =
1089 EOBJ_EVENT_DESCRIPTION("callback,add", "?", "Called when a callback was added.");
1090 EAPI const Eobj_Event_Description _EOBJ_SIG_CALLBACK_DEL =
1091 EOBJ_EVENT_DESCRIPTION("callback,del", "?", "Called when a callback was deleted.");
1094 _constructor(Eobj *obj)
1096 DBG("%p - %s.", obj, _my_class->desc->name);
1100 _destructor(Eobj *obj)
1102 DBG("%p - %s.", obj, _my_class->desc->name);
1105 EAPI const Eobj_Class *
1106 eobj_base_class_get(void)
1108 if (_my_class) return _my_class;
1110 static const Eobj_Class_Description class_desc = {
1112 EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT,
1113 EOBJ_CLASS_DESCRIPTION_OPS(NULL, NULL, 0),
1122 return _my_class = eobj_class_new(&class_desc, NULL, NULL);