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