lib/eobj.c

   1 #include <Eina.h>
   2
   3 #include "Eobj.h"
   4 #include "eobj_private.h"
   5
   6 #include "config.h"
   7
   8 typedef int Eobj_Class_Id;
   9
  10 int _eobj_log_dom = -1;
  11
  12 static Eobj_Class **_eobj_classes;
  13 static Eobj_Class_Id _eobj_classes_last_id;
  14 static Eina_Bool _eobj_init_count = 0;
  15
  16 static void _eobj_callback_remove_all(Eobj *obj);
  17 static void eobj_class_constructor(Eobj *obj, const Eobj_Class *klass);
  18 static void eobj_class_destructor(Eobj *obj, const Eobj_Class *klass);
  19 static void eobj_constructor_error_unset(Eobj *obj);
  20
  21 typedef struct _Eobj_Callback_Description Eobj_Callback_Description;
  22
  23 struct _Eobj {
  24      EINA_MAGIC
  25      Eobj *parent;
  26      const Eobj_Class *klass;
  27      void *data_blob;
  28      int refcount;
  29      Eina_List *composite_objects;
  30
  31      Eina_Inlist *callbacks;
  32      int walking_list;
  33
  34      Eina_Inlist *kls_itr;
  35
  36      Eina_Bool delete:1;
  37      Eina_Bool construct_error:1;
  38 };
  39
  40 /* Start of Dich */
  41 /* Dich search, split to 0xff 0xff 0xffff */
  42
  43 #define DICH_CHAIN1_MASK (0xff)
  44 #define DICH_CHAIN2_MASK (0xff)
  45 #define DICH_CHAIN_LAST_MASK (0xffff)
  46 #define DICH_CHAIN1_SIZE (DICH_CHAIN1_MASK + 1)
  47 #define DICH_CHAIN2_SIZE (DICH_CHAIN2_MASK + 1)
  48 #define DICH_CHAIN_LAST_SIZE (DICH_CHAIN_LAST_MASK + 1)
  49 #define DICH_CHAIN1(x) (((x) >> 24) & DICH_CHAIN1_MASK)
  50 #define DICH_CHAIN2(x) (((x) >> 16) & DICH_CHAIN2_MASK)
  51 #define DICH_CHAIN_LAST(x) ((x) & DICH_CHAIN_LAST_MASK)
  52
  53 #define OP_CLASS_OFFSET 16
  54 #define OP_CLASS_OFFSET_GET(x) (((x) >> OP_CLASS_OFFSET) & 0xffff)
  55 #define OP_CLASS_GET(op) ({ \
  56       Eobj_Class_Id tmp = OP_CLASS_OFFSET_GET(op); \
  57       (Eobj_Class *) ((tmp <= _eobj_classes_last_id) && (tmp > 0)) ? \
  58       (_eobj_classes[tmp - 1]) : NULL; \
  59       })
  60 #define OP_SUB_ID_GET(op) ((op) & 0xffff)
  61
  62 /* Structure of Eobj_Op is:
  63  * 16bit: class
  64  * 16bit: op.
  65  */
  66
  67 typedef struct _Dich_Chain1 Dich_Chain1;
  68
  69 typedef struct
  70 {
  71    eobj_op_func_type func;
  72 } op_type_funcs;
  73
  74 typedef struct
  75 {
  76    op_type_funcs *funcs;
  77 } Dich_Chain2;
  78
  79 struct _Dich_Chain1
  80 {
  81    Dich_Chain2 *chain;
  82 };
  83
  84 typedef struct
  85 {
  86      EINA_INLIST;
  87      const Eobj_Class *klass;
  88 } Eobj_Extension_Node;
  89
  90 struct _Eobj_Class
  91 {
  92    Eobj_Class_Id class_id;
  93    const Eobj_Class *parent;
  94    const Eobj_Class_Description *desc;
  95    Dich_Chain1 chain[DICH_CHAIN1_SIZE];
  96    Eina_Inlist *extensions;
  97
  98    const Eobj_Class **mro;
  99
 100    size_t data_offset; /* < Offset of the data within object data. */
 101
 102    Eina_Bool constructed : 1;
 103 };
 104
 105 static inline eobj_op_func_type
 106 dich_func_get(const Eobj_Class *klass, Eobj_Op op)
 107 {
 108    const Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
 109    if (!chain1) return NULL;
 110    if (!chain1->chain) return NULL;
 111    Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
 112    if (!chain2) return NULL;
 113    if (!chain2->funcs) return NULL;
 114
 115    /* num_ops is calculated from the class. */
 116    const Eobj_Class *op_klass = OP_CLASS_GET(op);
 117    if (!op_klass || (DICH_CHAIN_LAST(op) >= op_klass->desc->ops.count))
 118       return NULL;
 119
 120    return chain2->funcs[DICH_CHAIN_LAST(op)].func;
 121 }
 122
 123 static inline void
 124 dich_func_set(Eobj_Class *klass, Eobj_Op op, eobj_op_func_type func)
 125 {
 126    const Eobj_Class *op_klass = OP_CLASS_GET(op);
 127    size_t num_ops;
 128
 129    /* Verify op is valid. */
 130    if (op_klass)
 131      {
 132         /* num_ops is calculated from the class. */
 133         num_ops = op_klass->desc->ops.count;
 134         if (DICH_CHAIN_LAST(op) >= num_ops)
 135           {
 136              ERR("OP %x is too big for the domain '%s', expected value < %x.",
 137                    op, op_klass->desc->name, op_klass->desc->ops.count);
 138           }
 139      }
 140    else
 141      {
 142         ERR("OP %x is from an illegal class.", op);
 143         return;
 144      }
 145
 146    Dich_Chain1 *chain1 = &klass->chain[DICH_CHAIN1(op)];
 147    if (!chain1->chain)
 148      {
 149         klass->chain[DICH_CHAIN1(op)].chain =
 150            chain1->chain =
 151            calloc(DICH_CHAIN2_SIZE, sizeof(*(chain1->chain)));
 152      }
 153
 154    Dich_Chain2 *chain2 = &chain1->chain[DICH_CHAIN2(op)];
 155    if (!chain2->funcs)
 156      {
 157         chain2->funcs = chain1->chain[DICH_CHAIN2(op)].funcs =
 158            calloc(num_ops, sizeof(*(chain2->funcs)));
 159      }
 160
 161    chain2->funcs[DICH_CHAIN_LAST(op)].func = func;
 162 }
 163
 164 static inline void
 165 dich_func_clean_all(Eobj_Class *klass)
 166 {
 167    int i;
 168    Dich_Chain1 *chain1 = klass->chain;
 169
 170    for (i = 0 ; i < DICH_CHAIN1_SIZE ; i++, chain1++)
 171      {
 172         int j;
 173         Dich_Chain2 *chain2 = chain1->chain;
 174
 175         if (!chain2)
 176            continue;
 177
 178         for (j = 0 ; j < DICH_CHAIN2_SIZE ; j++, chain2++)
 179           {
 180              free(chain2->funcs);
 181           }
 182         free(chain1->chain);
 183         chain1->chain = NULL;
 184      }
 185 }
 186
 187 /* END OF DICH */
 188
 189 typedef struct
 190 {
 191    EINA_INLIST;
 192    Eobj_Op op;
 193    const Eobj_Class **kls_itr;
 194 } Eobj_Kls_Itr_Node;
 195
 196 static inline Eina_Bool
 197 _eobj_kls_itr_init(Eobj *obj, Eobj_Op op)
 198 {
 199    if (obj->kls_itr)
 200      {
 201         Eobj_Kls_Itr_Node *node =
 202            EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eobj_Kls_Itr_Node);
 203         if (node->op == op)
 204           {
 205              return EINA_FALSE;
 206           }
 207      }
 208
 209
 210      {
 211         Eobj_Kls_Itr_Node *node = calloc(1, sizeof(*node));
 212         node->op = op;
 213         node->kls_itr = obj->klass->mro;
 214         obj->kls_itr = eina_inlist_prepend(obj->kls_itr,
 215               EINA_INLIST_GET(node));
 216
 217         return EINA_TRUE;
 218      }
 219 }
 220
 221 static inline void
 222 _eobj_kls_itr_end(Eobj *obj, Eobj_Op op)
 223 {
 224    Eobj_Kls_Itr_Node *node =
 225       EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eobj_Kls_Itr_Node);
 226
 227    if (node->op != op)
 228       return;
 229
 230    obj->kls_itr = eina_inlist_remove(obj->kls_itr, obj->kls_itr);
 231    free(node);
 232 }
 233
 234 static inline const Eobj_Class *
 235 _eobj_kls_itr_get(Eobj *obj)
 236 {
 237    Eobj_Kls_Itr_Node *node =
 238       EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eobj_Kls_Itr_Node);
 239
 240    return (node) ? *(node->kls_itr) : NULL;
 241 }
 242
 243 static inline const Eobj_Class *
 244 _eobj_kls_itr_next(Eobj *obj)
 245 {
 246    Eobj_Kls_Itr_Node *node =
 247       EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eobj_Kls_Itr_Node);
 248    const Eobj_Class **kls_itr = node->kls_itr;
 249    if (*kls_itr)
 250      {
 251         kls_itr++;
 252         node->kls_itr = kls_itr;
 253         return *kls_itr;
 254      }
 255    else
 256      {
 257         return NULL;
 258      }
 259 }
 260
 261 static inline Eina_Bool
 262 _eobj_kls_itr_reached_end(const Eobj *obj)
 263 {
 264    Eobj_Kls_Itr_Node *node =
 265       EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eobj_Kls_Itr_Node);
 266    const Eobj_Class **kls_itr = node->kls_itr;
 267    return !(*kls_itr && *(kls_itr + 1));
 268 }
 269
 270 static const Eobj_Op_Description *
 271 _eobj_op_id_desc_get(Eobj_Op op)
 272 {
 273    const Eobj_Class *klass = OP_CLASS_GET(op);
 274    Eobj_Op sub_id = OP_SUB_ID_GET(op);
 275
 276    if (klass && (sub_id < klass->desc->ops.count))
 277       return klass->desc->ops.descs + sub_id;
 278
 279    return NULL;
 280 }
 281
 282 static Eina_Bool
 283 _eobj_op_internal(Eobj *obj, Eobj_Op op, va_list *p_list)
 284 {
 285    const Eobj_Class *klass;
 286    Eina_Bool ret = EINA_FALSE;
 287    Eina_Bool _itr_init;
 288
 289    _itr_init = _eobj_kls_itr_init(obj, op);
 290    klass = _eobj_kls_itr_get(obj);
 291    while (klass)
 292      {
 293         eobj_op_func_type func = dich_func_get(klass, op);
 294
 295         if (func)
 296           {
 297              func(obj, eobj_data_get(obj, klass), p_list);
 298              ret = EINA_TRUE;
 299              goto end;
 300           }
 301
 302         klass = _eobj_kls_itr_next(obj);
 303      }
 304
 305    /* Try composite objects */
 306      {
 307         Eina_List *itr;
 308         Eobj *emb_obj;
 309         EINA_LIST_FOREACH(obj->composite_objects, itr, emb_obj)
 310           {
 311              if (_eobj_op_internal(emb_obj, op, p_list))
 312                {
 313                   ret = EINA_TRUE;
 314                   goto end;
 315                }
 316           }
 317      }
 318
 319 end:
 320
 321    if (_itr_init) _eobj_kls_itr_end(obj, op);
 322    return ret;
 323 }
 324
 325 static inline Eina_Bool
 326 _eobj_ops_internal(Eobj *obj, va_list *p_list)
 327 {
 328    Eina_Bool ret = EINA_TRUE;
 329    Eobj_Op op = 0;
 330
 331    op = va_arg(*p_list, Eobj_Op);
 332    while (op)
 333      {
 334         if (!_eobj_op_internal(obj, op, p_list))
 335           {
 336              const Eobj_Op_Description *desc = _eobj_op_id_desc_get(op);
 337              const char *_id_name = (desc) ? desc->name : NULL;
 338              const Eobj_Class *op_klass = OP_CLASS_GET(op);
 339              const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL;
 340              ERR("Can't find func for op %x ('%s' of domain '%s') for class '%s'. Aborting.",
 341                    op, _id_name, _dom_name,
 342                    obj->klass->desc->name);
 343              ret = EINA_FALSE;
 344              break;
 345           }
 346         op = va_arg(*p_list, Eobj_Op);
 347      }
 348
 349    return ret;
 350 }
 351
 352 EAPI Eina_Bool
 353 eobj_do_internal(Eobj *obj, ...)
 354 {
 355    Eina_Bool ret;
 356    va_list p_list;
 357    eobj_ref(obj);
 358    va_start(p_list, obj);
 359    ret = _eobj_ops_internal(obj, &p_list);
 360    va_end(p_list);
 361    eobj_unref(obj);
 362    return ret;
 363 }
 364
 365 EAPI Eina_Bool
 366 eobj_do_super(Eobj *obj, Eobj_Op op, ...)
 367 {
 368    const Eobj_Class *obj_klass;
 369    Eina_Bool ret = EINA_TRUE;
 370    va_list p_list;
 371
 372    va_start(p_list, op);
 373
 374    /* Advance the kls itr. */
 375    obj_klass = _eobj_kls_itr_next(obj);
 376    if (!_eobj_op_internal(obj, op, &p_list))
 377      {
 378         const Eobj_Op_Description *desc = _eobj_op_id_desc_get(op);
 379         const char *_id_name = (desc) ? desc->name : NULL;
 380         const Eobj_Class *op_klass = OP_CLASS_GET(op);
 381         const char *_dom_name = (op_klass) ? op_klass->desc->name : NULL;
 382         ERR("Can't find func for op %x ('%s' of domain '%s') for class '%s'. Aborting.",
 383               op, _id_name, _dom_name,
 384               (obj_klass) ? obj_klass->desc->name : NULL);
 385         ret = EINA_FALSE;
 386      }
 387    va_end(p_list);
 388
 389    return ret;
 390 }
 391
 392 EAPI const Eobj_Class *
 393 eobj_class_get(const Eobj *obj)
 394 {
 395    return obj->klass;
 396 }
 397
 398 EAPI const char *
 399 eobj_class_name_get(const Eobj_Class *klass)
 400 {
 401    return klass->desc->name;
 402 }
 403
 404 static void
 405 _eobj_class_base_op_init(Eobj_Class *klass)
 406 {
 407    const Eobj_Class_Description *desc = klass->desc;
 408    if (!desc || !desc->ops.base_op_id)
 409       return;
 410
 411    /* FIXME: Depends on values defined above! */
 412    *(desc->ops.base_op_id) = klass->class_id << OP_CLASS_OFFSET;
 413 }
 414
 415 static Eina_List *
 416 _eobj_class_mro_add(Eina_List *mro, const Eobj_Class *klass)
 417 {
 418    if (!klass)
 419       return mro;
 420
 421    mro = eina_list_append(mro, klass);
 422
 423      {
 424         Eobj_Extension_Node *extn;
 425         EINA_INLIST_FOREACH(klass->extensions, extn)
 426           {
 427              mro = _eobj_class_mro_add(mro, extn->klass);
 428           }
 429      }
 430
 431    mro = _eobj_class_mro_add(mro, klass->parent);
 432
 433    return mro;
 434 }
 435
 436 static void
 437 _eobj_class_mro_init(Eobj_Class *klass)
 438 {
 439    Eina_List *mro = NULL;
 440
 441    DBG("Started creating MRO for class '%s'", klass->desc->name);
 442    mro = _eobj_class_mro_add(mro, klass);
 443
 444      {
 445         Eina_List *itr1, *itr2, *itr2n;
 446
 447         itr1 = eina_list_last(mro);
 448         while (itr1)
 449           {
 450              itr2 = eina_list_prev(itr1);
 451
 452              while (itr2)
 453                {
 454                   itr2n = eina_list_prev(itr2);
 455
 456                   if (eina_list_data_get(itr1) == eina_list_data_get(itr2))
 457                     {
 458                        mro = eina_list_remove_list(mro, itr2);
 459                     }
 460
 461                   itr2 = itr2n;
 462                }
 463
 464              itr1 = eina_list_prev(itr1);
 465           }
 466      }
 467
 468    /* Copy the mro and free the list. */
 469      {
 470         const Eobj_Class *kls_itr;
 471         const Eobj_Class **mro_itr;
 472         klass->mro = calloc(sizeof(*klass->mro), eina_list_count(mro) + 1);
 473
 474         mro_itr = klass->mro;
 475
 476         EINA_LIST_FREE(mro, kls_itr)
 477           {
 478              *(mro_itr++) = kls_itr;
 479
 480              DBG("Added '%s' to MRO", kls_itr->desc->name);
 481           }
 482         *(mro_itr) = NULL;
 483      }
 484
 485    DBG("Finished creating MRO for class '%s'", klass->desc->name);
 486 }
 487
 488 static void
 489 _eobj_class_constructor(Eobj_Class *klass)
 490 {
 491    if (klass->constructed)
 492       return;
 493
 494    klass->constructed = EINA_TRUE;
 495
 496    if (klass->desc->class_constructor)
 497       klass->desc->class_constructor(klass);
 498
 499    _eobj_class_mro_init(klass);
 500 }
 501
 502 EAPI void
 503 eobj_class_funcs_set(Eobj_Class *klass, const Eobj_Op_Func_Description *func_descs)
 504 {
 505    const Eobj_Op_Func_Description *itr;
 506    itr = func_descs;
 507    if (itr)
 508      {
 509         for ( ; itr->op != 0 ; itr++)
 510           {
 511              dich_func_set(klass, itr->op, itr->func);
 512           }
 513      }
 514 }
 515
 516 void
 517 eobj_class_free(Eobj_Class *klass)
 518 {
 519    if (klass->constructed)
 520      {
 521         if (klass->desc->class_destructor)
 522            klass->desc->class_destructor(klass);
 523
 524         dich_func_clean_all(klass);
 525      }
 526
 527      {
 528         Eina_Inlist *itrn;
 529         Eobj_Extension_Node *extn;
 530         EINA_INLIST_FOREACH_SAFE(klass->extensions, itrn, extn)
 531           {
 532              free(extn);
 533           }
 534      }
 535
 536    free(klass->mro);
 537
 538    free(klass);
 539 }
 540
 541 /* DEVCHECK */
 542 static Eina_Bool
 543 _eobj_class_check_op_descs(const Eobj_Class *klass)
 544 {
 545    const Eobj_Class_Description *desc = klass->desc;
 546    const Eobj_Op_Description *itr;
 547    size_t i;
 548
 549    if (desc->ops.count > 0)
 550      {
 551         if (!desc->ops.base_op_id)
 552           {
 553              ERR("Class '%s' has a non-zero ops count, but base_id is NULL.",
 554                    desc->name);
 555              return EINA_FALSE;
 556           }
 557
 558         if (!desc->ops.descs)
 559           {
 560              ERR("Class '%s' has a non-zero ops count, but there are no descs.",
 561                    desc->name);
 562              return EINA_FALSE;
 563           }
 564      }
 565
 566    itr = desc->ops.descs;
 567    for (i = 0 ; i < desc->ops.count ; i++, itr++)
 568      {
 569         if (itr->sub_op != i)
 570           {
 571              if (itr->name)
 572                {
 573                   ERR("Wrong order in Ops description for class '%s'. Expected %d and got %d", desc->name, i, itr->sub_op);
 574                }
 575              else
 576                {
 577                   ERR("Found too few Ops description for class '%s'. Expected %d descriptions, but found %d.", desc->name, desc->ops.count, i);
 578                }
 579              return EINA_FALSE;
 580           }
 581      }
 582
 583    if (itr && itr->name)
 584      {
 585         ERR("Found extra Ops description for class '%s'. Expected %d descriptions, but found more.", desc->name, desc->ops.count);
 586         return EINA_FALSE;
 587      }
 588
 589    return EINA_TRUE;
 590 }
 591
 592 EAPI const Eobj_Class *
 593 eobj_class_new(const Eobj_Class_Description *desc, const Eobj_Class *parent, ...)
 594 {
 595    Eobj_Class *klass;
 596    va_list p_list;
 597
 598    va_start(p_list, parent);
 599
 600 #define _CLS_NEW_CHECK(x) \
 601    do \
 602      { \
 603         if (!x) \
 604           { \
 605              ERR("%s must not be NULL! Aborting.", #x); \
 606              return NULL; \
 607           } \
 608      } \
 609    while(0)
 610
 611    _CLS_NEW_CHECK(desc);
 612    _CLS_NEW_CHECK(desc->name);
 613
 614    klass = calloc(1, sizeof(Eobj_Class));
 615    klass->parent = parent;
 616
 617    /* Handle class extensions */
 618      {
 619         Eobj_Class *extn = NULL;
 620
 621         extn = va_arg(p_list, Eobj_Class *);
 622         while (extn)
 623           {
 624              switch (extn->desc->type)
 625                {
 626                 case EOBJ_CLASS_TYPE_REGULAR:
 627                 case EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT:
 628                    /* Use it like an interface. */
 629                 case EOBJ_CLASS_TYPE_INTERFACE:
 630                    break;
 631                 case EOBJ_CLASS_TYPE_MIXIN:
 632                      {
 633                         Eobj_Extension_Node *node = calloc(1, sizeof(*node));
 634                         node->klass = extn;
 635                         klass->extensions =
 636                            eina_inlist_append(klass->extensions,
 637                                  EINA_INLIST_GET(node));
 638                      }
 639                    break;
 640                }
 641
 642              extn = va_arg(p_list, Eobj_Class *);
 643           }
 644      }
 645
 646    klass->desc = desc;
 647
 648    /* Handle the inheritance */
 649    if (klass->parent)
 650      {
 651         /* Verify the inheritance is allowed. */
 652         switch (klass->desc->type)
 653           {
 654            case EOBJ_CLASS_TYPE_REGULAR:
 655            case EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT:
 656               if ((klass->parent->desc->type != EOBJ_CLASS_TYPE_REGULAR) &&
 657                     (klass->parent->desc->type != EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT))
 658                 {
 659                    ERR("Regular classes ('%s') aren't allowed to inherit from non-regular classes ('%s').", klass->desc->name, klass->parent->desc->name);
 660                    goto cleanup;
 661                 }
 662               break;
 663            case EOBJ_CLASS_TYPE_INTERFACE:
 664            case EOBJ_CLASS_TYPE_MIXIN:
 665               if ((klass->parent->desc->type != EOBJ_CLASS_TYPE_INTERFACE) &&
 666                     (klass->parent->desc->type != EOBJ_CLASS_TYPE_MIXIN))
 667                 {
 668                    ERR("Non-regular classes ('%s') aren't allowed to inherit from regular classes ('%s').", klass->desc->name, klass->parent->desc->name);
 669                    goto cleanup;
 670                 }
 671               break;
 672           }
 673
 674
 675         /* Update the current offset. */
 676         /* FIXME: Make sure this alignment is enough. */
 677         klass->data_offset = klass->parent->data_offset +
 678            klass->parent->desc->data_size +
 679            (sizeof(void *) -
 680                   (klass->parent->desc->data_size % sizeof(void *)));
 681      }
 682
 683    if (!_eobj_class_check_op_descs(klass))
 684      {
 685         goto cleanup;
 686      }
 687
 688    klass->class_id = ++_eobj_classes_last_id;
 689      {
 690         /* FIXME: Handle errors. */
 691         Eobj_Class **tmp;
 692         tmp = realloc(_eobj_classes, _eobj_classes_last_id * sizeof(*_eobj_classes));
 693         _eobj_classes = tmp;
 694         _eobj_classes[klass->class_id - 1] = klass;
 695      }
 696
 697    _eobj_class_base_op_init(klass);
 698
 699    /* FIXME: Shouldn't be called here - should be called from eobj_add. */
 700    _eobj_class_constructor(klass);
 701
 702    va_end(p_list);
 703
 704    return klass;
 705
 706 cleanup:
 707    eobj_class_free(klass);
 708    return NULL;
 709 }
 710 #undef _CLS_NEW_CHECK
 711
 712 EAPI Eobj *
 713 eobj_add(const Eobj_Class *klass, Eobj *parent)
 714 {
 715    if (klass->desc->type != EOBJ_CLASS_TYPE_REGULAR)
 716      {
 717         ERR("Class '%s' is not instantiate-able. Aborting.", klass->desc->name);
 718         return NULL;
 719      }
 720
 721    Eobj *obj = calloc(1, sizeof(*obj));
 722    obj->klass = klass;
 723    obj->parent = parent;
 724
 725    obj->refcount++;
 726
 727    obj->data_blob = calloc(1, klass->data_offset + klass->desc->data_size);
 728
 729    _eobj_kls_itr_init(obj, EOBJ_NOOP);
 730    eobj_constructor_error_unset(obj);
 731
 732    eobj_ref(obj);
 733    eobj_class_constructor(obj, klass);
 734
 735    if (eobj_constructor_error_get(obj))
 736      {
 737         ERR("Type '%s' - One of the object constructors have failed.", klass->desc->name);
 738         goto fail;
 739      }
 740
 741    if (!_eobj_kls_itr_reached_end(obj))
 742      {
 743         ERR("Type '%s' - Not all of the object constructors have been executed.", klass->desc->name);
 744         goto fail;
 745      }
 746    _eobj_kls_itr_end(obj, EOBJ_NOOP);
 747    eobj_unref(obj);
 748
 749    return obj;
 750
 751 fail:
 752    /* Unref twice, once for the ref above, and once for the basic object ref. */
 753    eobj_unref(obj);
 754    eobj_unref(obj);
 755    return NULL;
 756 }
 757
 758 EAPI Eobj *
 759 eobj_ref(Eobj *obj)
 760 {
 761    obj->refcount++;
 762    return obj;
 763 }
 764
 765 EAPI void
 766 eobj_unref(Eobj *obj)
 767 {
 768    if (--(obj->refcount) == 0)
 769      {
 770         /* We need that for the event callbacks that may ref/unref. */
 771         obj->refcount++;
 772
 773         if (!obj->delete)
 774           {
 775              eobj_event_callback_call(obj, EOBJ_EV_DEL, NULL);
 776              obj->delete = EINA_TRUE;
 777           }
 778         eobj_event_callback_call(obj, EOBJ_EV_FREE, NULL);
 779
 780         obj->refcount--;
 781
 782         const Eobj_Class *klass = eobj_class_get(obj);
 783         _eobj_kls_itr_init(obj, EOBJ_NOOP);
 784         eobj_constructor_error_unset(obj);
 785         eobj_class_destructor(obj, klass);
 786         if (eobj_constructor_error_get(obj))
 787           {
 788              ERR("Type '%s' - One of the object destructors have failed.", klass->desc->name);
 789           }
 790
 791         if (!_eobj_kls_itr_reached_end(obj))
 792           {
 793              ERR("Type '%s' - Not all of the object destructors have been executed.", klass->desc->name);
 794           }
 795         _eobj_kls_itr_end(obj, EOBJ_NOOP);
 796         /*FIXME: add eobj_class_unref(klass) ? - just to clear the caches. */
 797
 798         /* If for some reason it's not empty, clear it. */
 799         while (obj->kls_itr)
 800           {
 801              WRN("Kls_Itr is not empty, possibly a bug, please report. - An error will be reported for each kls_itr in the stack.");
 802              Eina_Inlist *nitr = nitr->next;
 803              free(EINA_INLIST_CONTAINER_GET(obj->kls_itr, Eobj_Kls_Itr_Node));
 804              obj->kls_itr = nitr;
 805           }
 806
 807         Eina_List *itr, *itr_n;
 808         Eobj *emb_obj;
 809         EINA_LIST_FOREACH_SAFE(obj->composite_objects, itr, itr_n, emb_obj)
 810           {
 811              /* FIXME: Should probably be unref. */
 812              eobj_del(emb_obj);
 813              obj->composite_objects =
 814                 eina_list_remove_list(obj->composite_objects, itr);
 815           }
 816
 817         _eobj_callback_remove_all(obj);
 818
 819         if (obj->data_blob)
 820            free(obj->data_blob);
 821
 822         free(obj);
 823      }
 824 }
 825
 826 EAPI int
 827 eobj_ref_get(const Eobj *obj)
 828 {
 829    return obj->refcount;
 830 }
 831
 832 EAPI void
 833 eobj_del(Eobj *obj)
 834 {
 835    if (!obj->delete)
 836      {
 837         eobj_event_callback_call(obj, EOBJ_EV_DEL, NULL);
 838         obj->delete = EINA_TRUE;
 839      }
 840    eobj_unref(obj);
 841 }
 842
 843 EAPI Eobj *
 844 eobj_parent_get(Eobj *obj)
 845 {
 846    return obj->parent;
 847 }
 848
 849 EAPI void
 850 eobj_constructor_error_set(Eobj *obj)
 851 {
 852    obj->construct_error = EINA_TRUE;
 853 }
 854
 855 static void
 856 eobj_constructor_error_unset(Eobj *obj)
 857 {
 858    obj->construct_error = EINA_FALSE;
 859 }
 860
 861 EAPI Eina_Bool
 862 eobj_constructor_error_get(const Eobj *obj)
 863 {
 864    return obj->construct_error;
 865 }
 866
 867 static inline void
 868 _eobj_constructor_default(Eobj *obj)
 869 {
 870    eobj_constructor_super(obj);
 871 }
 872
 873 static inline void
 874 _eobj_destructor_default(Eobj *obj)
 875 {
 876    eobj_destructor_super(obj);
 877 }
 878
 879 static void
 880 eobj_class_constructor(Eobj *obj, const Eobj_Class *klass)
 881 {
 882    if (!klass)
 883       return;
 884
 885    if (klass->desc->constructor)
 886       klass->desc->constructor(obj, eobj_data_get(obj, klass));
 887    else
 888       _eobj_constructor_default(obj);
 889 }
 890
 891 static void
 892 eobj_class_destructor(Eobj *obj, const Eobj_Class *klass)
 893 {
 894    if (!klass)
 895       return;
 896
 897    if (klass->desc->destructor)
 898       klass->desc->destructor(obj, eobj_data_get(obj, klass));
 899    else
 900       _eobj_destructor_default(obj);
 901 }
 902
 903 EAPI void
 904 eobj_constructor_super(Eobj *obj)
 905 {
 906    eobj_class_constructor(obj, _eobj_kls_itr_next(obj));
 907 }
 908
 909 EAPI void
 910 eobj_destructor_super(Eobj *obj)
 911 {
 912    eobj_class_destructor(obj, _eobj_kls_itr_next(obj));
 913 }
 914
 915 EAPI void *
 916 eobj_data_get(Eobj *obj, const Eobj_Class *klass)
 917 {
 918    /* FIXME: Add a check that this is of the right klass and we don't seg.
 919     * Probably just return NULL. */
 920    if (klass->desc->data_size > 0)
 921       return ((char *) obj->data_blob) + klass->data_offset;
 922    else
 923       return NULL;
 924 }
 925
 926 EAPI Eina_Bool
 927 eobj_init(void)
 928 {
 929    const char *log_dom = "eobj";
 930    if (_eobj_init_count++ > 0)
 931       return EINA_TRUE;
 932
 933    eina_init();
 934
 935    _eobj_classes = NULL;
 936    _eobj_classes_last_id = 0;
 937    _eobj_log_dom = eina_log_domain_register(log_dom, EINA_COLOR_LIGHTBLUE);
 938    if (_eobj_log_dom < 0)
 939      {
 940         EINA_LOG_ERR("Could not register log domain: %s", log_dom);
 941         return EINA_FALSE;
 942      }
 943
 944    return EINA_TRUE;
 945 }
 946
 947 EAPI Eina_Bool
 948 eobj_shutdown(void)
 949 {
 950    int i;
 951    Eobj_Class **cls_itr = _eobj_classes;
 952
 953    if (--_eobj_init_count > 0)
 954       return EINA_TRUE;
 955
 956    for (i = 0 ; i < _eobj_classes_last_id ; i++, cls_itr++)
 957      {
 958         if (*cls_itr)
 959            eobj_class_free(*cls_itr);
 960      }
 961
 962    if (_eobj_classes)
 963       free(_eobj_classes);
 964
 965    eina_log_domain_unregister(_eobj_log_dom);
 966    _eobj_log_dom = -1;
 967
 968    eina_shutdown();
 969    return EINA_TRUE;
 970 }
 971
 972 EAPI void
 973 eobj_composite_object_attach(Eobj *obj, Eobj *emb_obj)
 974 {
 975    eobj_ref(emb_obj);
 976    obj->composite_objects = eina_list_prepend(obj->composite_objects, emb_obj);
 977 }
 978
 979 EAPI void
 980 eobj_composite_object_detach(Eobj *obj, Eobj *emb_obj)
 981 {
 982    obj->composite_objects = eina_list_remove(obj->composite_objects, emb_obj);
 983    eobj_unref(emb_obj);
 984 }
 985
 986 EAPI Eina_Bool
 987 eobj_composite_is(Eobj *emb_obj)
 988 {
 989    Eobj *obj = eobj_parent_get(emb_obj);
 990    Eina_List *itr;
 991    Eobj *tmp;
 992
 993    if (!obj)
 994       return EINA_FALSE;
 995
 996    EINA_LIST_FOREACH(obj->composite_objects, itr, tmp)
 997      {
 998         if (tmp == emb_obj)
 999            return EINA_TRUE;
1000      }
1001
1002    return EINA_FALSE;
1003 }
1004
1005 /* Callbacks */
1006 struct _Eobj_Callback_Description
1007 {
1008    EINA_INLIST;
1009    const Eobj_Event_Description *event;
1010    Eobj_Event_Cb func;
1011    void *func_data;
1012    Eobj_Callback_Priority priority;
1013    Eina_Bool delete_me : 1;
1014 };
1015
1016 /* Actually remove, doesn't care about walking list, or delete_me */
1017 static void
1018 _eobj_callback_remove(Eobj *obj, Eobj_Callback_Description *cb)
1019 {
1020    obj->callbacks = eina_inlist_remove(obj->callbacks,
1021          EINA_INLIST_GET(cb));
1022    free(cb);
1023 }
1024
1025 /* Actually remove, doesn't care about walking list, or delete_me */
1026 static void
1027 _eobj_callback_remove_all(Eobj *obj)
1028 {
1029    Eina_Inlist *initr;
1030    Eobj_Callback_Description *cb;
1031    EINA_INLIST_FOREACH_SAFE(obj->callbacks, initr, cb)
1032      {
1033         _eobj_callback_remove(obj, cb);
1034      }
1035 }
1036
1037 static void
1038 _eobj_callbacks_clear(Eobj *obj)
1039 {
1040    Eina_Inlist *itn;
1041    Eobj_Callback_Description *cb;
1042
1043    /* Abort if we are currently walking the list. */
1044    if (obj->walking_list > 0)
1045       return;
1046
1047    EINA_INLIST_FOREACH_SAFE(obj->callbacks, itn, cb)
1048      {
1049         if (cb->delete_me)
1050           {
1051              _eobj_callback_remove(obj, cb);
1052           }
1053      }
1054 }
1055
1056 static int
1057 _callback_priority_cmp(const void *_a, const void *_b)
1058 {
1059    const Eobj_Callback_Description *a, *b;
1060    a = (const Eobj_Callback_Description *) _a;
1061    b = (const Eobj_Callback_Description *) _b;
1062    if (a->priority < b->priority)
1063       return -1;
1064    else
1065       return 1;
1066 }
1067
1068 EAPI Eina_Bool
1069 eobj_event_callback_priority_add(Eobj *obj,
1070       const Eobj_Event_Description *desc,
1071       Eobj_Callback_Priority priority,
1072       Eobj_Event_Cb func,
1073       const void *data)
1074 {
1075    Eobj_Callback_Description *cb = calloc(1, sizeof(*cb));
1076    cb->event = desc;
1077    cb->func = func;
1078    cb->func_data = (void *) data;
1079    cb->priority = priority;
1080    obj->callbacks = eina_inlist_sorted_insert(obj->callbacks,
1081          EINA_INLIST_GET(cb), _callback_priority_cmp);
1082
1083    eobj_event_callback_call(obj, EOBJ_EV_CALLBACK_ADD, desc);
1084
1085    return EINA_TRUE;
1086 }
1087
1088 EAPI void *
1089 eobj_event_callback_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func)
1090 {
1091    void *ret = NULL;
1092    Eobj_Callback_Description *cb;
1093    EINA_INLIST_FOREACH(obj->callbacks, cb)
1094      {
1095         if ((cb->event == desc) && (cb->func == func))
1096           {
1097              void *data;
1098
1099              data = cb->func_data;
1100              cb->delete_me = EINA_TRUE;
1101              _eobj_callbacks_clear(obj);
1102              ret = data;
1103              goto found;
1104           }
1105      }
1106
1107    return NULL;
1108
1109 found:
1110    eobj_event_callback_call(obj, EOBJ_EV_CALLBACK_DEL, desc);
1111    return ret;
1112 }
1113
1114 EAPI void *
1115 eobj_event_callback_del_full(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func, const void *user_data)
1116 {
1117    void *ret = NULL;
1118    Eobj_Callback_Description *cb;
1119    EINA_INLIST_FOREACH(obj->callbacks, cb)
1120      {
1121         if ((cb->event == desc) && (cb->func == func) &&
1122               (cb->func_data == user_data))
1123           {
1124              void *data;
1125
1126              data = cb->func_data;
1127              cb->delete_me = EINA_TRUE;
1128              _eobj_callbacks_clear(obj);
1129              ret = data;
1130              goto found;
1131           }
1132      }
1133
1134    return NULL;
1135
1136 found:
1137    eobj_event_callback_call(obj, EOBJ_EV_CALLBACK_DEL, desc);
1138    return ret;
1139 }
1140
1141 EAPI Eina_Bool
1142 eobj_event_callback_call(Eobj *obj, const Eobj_Event_Description *desc,
1143       const void *event_info)
1144 {
1145    Eina_Bool ret = EINA_TRUE;
1146    Eobj_Callback_Description *cb;
1147
1148    eobj_ref(obj);
1149    obj->walking_list++;
1150
1151    EINA_INLIST_FOREACH(obj->callbacks, cb)
1152      {
1153         if (!cb->delete_me  && (cb->event == desc))
1154           {
1155              /* Abort callback calling if the func says so. */
1156              if (!cb->func((void *) cb->func_data, obj, desc,
1157                       (void *) event_info))
1158                {
1159                   ret = EINA_FALSE;
1160                   break;
1161                }
1162           }
1163         if (obj->delete)
1164           break;
1165      }
1166    obj->walking_list--;
1167    _eobj_callbacks_clear(obj);
1168    eobj_unref(obj);
1169
1170    return ret;
1171 }
1172
1173 static Eina_Bool
1174 _eobj_event_forwarder_callback(void *data, Eobj *obj, const Eobj_Event_Description *desc, void *event_info)
1175 {
1176    (void) obj;
1177    Eobj *new_obj = (Eobj *) data;
1178    return eobj_event_callback_call(new_obj, desc, event_info);
1179 }
1180
1181 /* FIXME: Change default priority? Maybe call later? */
1182 EAPI Eina_Bool
1183 eobj_event_callback_forwarder_add(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj)
1184 {
1185    return eobj_event_callback_add(obj, desc, _eobj_event_forwarder_callback, new_obj);
1186 }
1187
1188 EAPI Eina_Bool
1189 eobj_event_callback_forwarder_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj)
1190 {
1191    eobj_event_callback_del_full(obj, desc, _eobj_event_forwarder_callback, new_obj);
1192    return EINA_TRUE;
1193 }
1194