lib/eo.c

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