lib/Eo.h

   1 #ifndef EO_H
   2 #define EO_H
   3
   4 #include <stdarg.h>
   5 #include <Eina.h>
   6
   7 #ifdef EAPI
   8 # undef EAPI
   9 #endif
  10
  11 #ifdef _WIN32
  12 # ifdef EFL_EO_BUILD
  13 #  ifdef DLL_EXPORT
  14 #   define EAPI __declspec(dllexport)
  15 #  else
  16 #   define EAPI
  17 #  endif /* ! DLL_EXPORT */
  18 # else
  19 #  define EAPI __declspec(dllimport)
  20 # endif /* ! EFL_EO_BUILD */
  21 #else
  22 # ifdef __GNUC__
  23 #  if __GNUC__ >= 4
  24 #   define EAPI __attribute__ ((visibility("default")))
  25 #  else
  26 #   define EAPI
  27 #  endif
  28 # else
  29 #  define EAPI
  30 # endif
  31 #endif /* ! _WIN32 */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /**
  38  * @def EO_OP_CLASS_OFFSET
  39  * The bit offset of the class inside the ops.
  40  * @internal
  41  */
  42 #define EO_OP_CLASS_OFFSET 16
  43
  44 /**
  45  * @def EO_CLASS_ID_TO_BASE_ID(class_id)
  46  * Translates a class id to an op base id.
  47  * @internal
  48  */
  49 #define EO_CLASS_ID_TO_BASE_ID(class_id) ((class_id) << EO_OP_CLASS_OFFSET)
  50
  51 /**
  52  * @var _eo_class_creation_lock
  53  * This variable is used for locking purposes in the class_get function
  54  * defined in #EO_DEFINE_CLASS.
  55  * This is just to work around the fact that we need to init locks before
  56  * using them.
  57  * Don't touch it if you don't know what you are doing.
  58  * @internal
  59  */
  60 EAPI extern Eina_Lock _eo_class_creation_lock;
  61
  62 /**
  63  * @internal
  64  * An enum representing the possible types of an Op.
  65  */
  66 enum _Eo_Op_Type
  67 {
  68    EO_OP_TYPE_INVALID = -1, /**< Invalid op. */
  69    EO_OP_TYPE_REGULAR = 0, /**< Regular op. */
  70    EO_OP_TYPE_CONST, /**< Const op - object should not change. */
  71    EO_OP_TYPE_CLASS, /**< Class op - a class op. Like static in Java/C++. */
  72 };
  73
  74 /**
  75  * @internal
  76  * @typedef Eo_Op_Type
  77  * A convenience typedef for #_Eo_Op_Type.
  78  */
  79 typedef enum _Eo_Op_Type Eo_Op_Type;
  80
  81 /**
  82  * @defgroup Eo Eo Generic Object System
  83  *
  84  * The Eo generic object system. It was designed to be the base object
  85  * system for the EFL.
  86  *
  87  * @{
  88  */
  89
  90 /**
  91  * @def EO_TYPECHECK(type, x)
  92  *
  93  * Checks x is castable to type "type" and casts it to it.
  94  * @param type The C type to check against.
  95  * @param x the variable to test and cast.
  96  */
  97 #define EO_TYPECHECK(type, x) \
  98    ({ \
  99     type __x; \
 100     __x = x; \
 101     (type) __x; \
 102     })
 103
 104 /**
 105  * @typedef Eo
 106  * The basic Object type.
 107  */
 108 typedef struct _Eo Eo;
 109 /**
 110  * @typedef Eo_Op
 111  * The Eo operation type id.
 112  */
 113 typedef unsigned int Eo_Op;
 114
 115 /**
 116  * @typedef Eo_Class
 117  * The basic Object class type.
 118  * @ingroup Eo_Class
 119  */
 120 typedef struct _Eo_Class Eo_Class;
 121
 122 /**
 123  * @typedef Eo_Class_Id
 124  * An Id of a class.
 125  * @ingroup Eo_Class
 126  */
 127 typedef size_t Eo_Class_Id;
 128
 129 /**
 130  * @def EO_NOOP
 131  * A special #Eo_Op meaning "No operation".
 132  */
 133 #define EO_NOOP ((Eo_Op) 0)
 134
 135 /**
 136  * @typedef eo_op_func_type
 137  * The type of the Op functions. This is the type of the functions used by
 138  * Eo.
 139  *
 140  * @see eo_op_func_type_const
 141  */
 142 typedef void (*eo_op_func_type)(Eo *, void *class_data, va_list *list);
 143
 144 /**
 145  * @typedef eo_op_func_type_const
 146  * The type of the const Op functions. This is the type of the functions used
 147  * by Eo. This is the same as #eo_op_func_type, except that this should
 148  * be used with functions that don't modify the data.
 149  *
 150  * @see eo_op_func_type
 151  */
 152 typedef void (*eo_op_func_type_const)(const Eo *, const void *class_data, va_list *list);
 153
 154 /**
 155  * @typedef eo_op_func_type_class
 156  * The type of the class Op functions. This is the same as #eo_op_func_type,\
 157  * exepct that it's for usage with class functions, and not with object
 158  * functions.
 159  *
 160  * @see eo_op_func_type
 161  */
 162 typedef void (*eo_op_func_type_class)(const Eo_Class *, va_list *list);
 163
 164 /**
 165  * @addtogroup Eo_Events Eo's Event Handling
 166  * @{
 167  */
 168
 169 /**
 170  * @struct _Eo_Event_Description
 171  * This struct holds the description of a specific event.
 172  */
 173 struct _Eo_Event_Description
 174 {
 175    const char *name; /**< name of the event. */
 176    const char *doc; /**< Explanation about the event. */
 177 };
 178
 179 /**
 180  * @typedef Eo_Event_Description
 181  * A convenience typedef for #_Eo_Event_Description
 182  */
 183 typedef struct _Eo_Event_Description Eo_Event_Description;
 184
 185 /**
 186  * @def EO_EVENT_DESCRIPTION(name, doc)
 187  * An helper macro to help populating #Eo_Event_Description
 188  * @param name The name of the event.
 189  * @param doc Additional doc for the event.
 190  * @see Eo_Event_Description
 191  */
 192 #define EO_EVENT_DESCRIPTION(name, doc) { name, doc }
 193
 194 /**
 195  * @}
 196  */
 197
 198 /**
 199  * @addtogroup Eo_Class Eo Class
 200  * @{
 201  */
 202
 203 /**
 204  * @def EO_DEFINE_CLASS(class_get_func_name, class_desc, parent_class, ...)
 205  * A convenience macro to be used for creating the class_get function. This
 206  * macro is fairly simple but should still be used as it'll let us improve
 207  * things easily.
 208  * @param class_get_func_name the name of the wanted class_get function name.
 209  * @param class_desc the class description.
 210  * @param parent_class The parent class for the function. Look at eo_class_new() for more information.
 211  * @param ... List of etxensions. Look at eo_class_new() for more information.
 212  *
 213  * You must use this macro if you want thread safety in class creation.
 214  */
 215 #define EO_DEFINE_CLASS(class_get_func_name, class_desc, parent_class, ...) \
 216    EO_DEFINE_CLASS_STATIC(class_get_func_name, 0, class_desc, parent_class, __VA_ARGS__)
 217
 218 /**
 219  * @def EO_DEFINE_CLASS_STATIC(class_get_func_name, id, class_desc, parent_class, ...)
 220  * *** DO NOT USE UNLESS YOU REALLY KNOW WHAT YOU ARE DOING ***
 221  * @param id a positive number to serve as the id of the class. 0 means dynamic. See eo_class_new() for details.
 222  * @param class_get_func_name the name of the wanted class_get function name.
 223  * @param class_desc the class description.
 224  * @param parent_class The parent class for the function. Look at eo_class_new() for more information.
 225  * @param ... List of etxensions. Look at eo_class_new() for more information.
 226  *
 227  * This macro should only be used if you know what you are doing and you want
 228  * to create a class with a static id.
 229  * Use #EO_DEFINE_CLASS instead.
 230  *
 231  * @see #EO_DEFINE_CLASS
 232  */
 233 #define EO_DEFINE_CLASS_STATIC(class_get_func_name, id, class_desc, parent_class, ...) \
 234 EAPI const Eo_Class * \
 235 class_get_func_name(void) \
 236 { \
 237    static volatile char lk_init = 0; \
 238    static Eina_Lock _my_lock; \
 239    static const Eo_Class * volatile _my_class = NULL; \
 240    if (EINA_LIKELY(!!_my_class)) return _my_class; \
 241    \
 242    eina_lock_take(&_eo_class_creation_lock); \
 243    if (!lk_init) \
 244       eina_lock_new(&_my_lock); \
 245    if (lk_init < 2) eina_lock_take(&_my_lock); \
 246    if (!lk_init) \
 247       lk_init = 1; \
 248    else \
 249      { \
 250         if (lk_init < 2) eina_lock_release(&_my_lock); \
 251         eina_lock_release(&_eo_class_creation_lock); \
 252         return _my_class; \
 253      } \
 254    eina_lock_release(&_eo_class_creation_lock); \
 255    _my_class = eo_class_new(class_desc, id, parent_class, __VA_ARGS__); \
 256    eina_lock_release(&_my_lock); \
 257    \
 258    eina_lock_take(&_eo_class_creation_lock); \
 259    eina_lock_free(&_my_lock); \
 260    lk_init = 2; \
 261    eina_lock_release(&_eo_class_creation_lock); \
 262    return _my_class; \
 263 }
 264
 265
 266 /**
 267  * An enum representing the possible types of an Eo class.
 268  */
 269 enum _Eo_Class_Type
 270 {
 271    EO_CLASS_TYPE_REGULAR = 0, /**< Regular class. */
 272    EO_CLASS_TYPE_REGULAR_NO_INSTANT, /**< Regular non instant-able class. */
 273    EO_CLASS_TYPE_INTERFACE, /**< Interface */
 274    EO_CLASS_TYPE_MIXIN /**< Mixin */
 275 };
 276
 277 /**
 278  * @typedef Eo_Class_Type
 279  * A convenience typedef for #_Eo_Class_Type.
 280  */
 281 typedef enum _Eo_Class_Type Eo_Class_Type;
 282
 283 /**
 284  * @struct _Eo_Op_Func_Description
 285  * Used to associate an Op with a func.
 286  * @see eo_class_funcs_set
 287  */
 288 struct _Eo_Op_Func_Description
 289 {
 290    Eo_Op op; /**< The op */
 291    eo_op_func_type func; /**< The function to call for the op. */
 292    Eo_Op_Type op_type; /**< The type of the op */
 293 };
 294
 295 /**
 296  * @typedef Eo_Op_Func_Description
 297  * A convenience typedef for #_Eo_Op_Func_Description
 298  */
 299 typedef struct _Eo_Op_Func_Description Eo_Op_Func_Description;
 300
 301 /**
 302  * @def EO_OP_FUNC(op, func)
 303  * A convenience macro to be used when populating the #Eo_Op_Func_Description
 304  * array.
 305  *
 306  * @see EO_OP_FUNC_CONST
 307  */
 308 #define EO_OP_FUNC(op, func) { op, EO_TYPECHECK(eo_op_func_type, func), EO_OP_TYPE_REGULAR }
 309
 310 /**
 311  * @def EO_OP_FUNC_CONST(op, func)
 312  * A convenience macro to be used when populating the #Eo_Op_Func_Description
 313  * array.
 314  * The same as #EO_OP_FUNC but for const functions.
 315  *
 316  * @see EO_OP_FUNC
 317  */
 318 #define EO_OP_FUNC_CONST(op, func) { op, (eo_op_func_type) EO_TYPECHECK(eo_op_func_type_const, func), EO_OP_TYPE_CONST }
 319
 320 /**
 321  * @def EO_OP_FUNC_CLASS(op, func)
 322  * A convenience macro to be used when populating the #Eo_Op_Func_Description
 323  * array.
 324  * The same as #EO_OP_FUNC but for class functions.
 325  *
 326  * @see EO_OP_FUNC
 327  */
 328 #define EO_OP_FUNC_CLASS(op, func) { op, (eo_op_func_type) EO_TYPECHECK(eo_op_func_type_class, func), EO_OP_TYPE_CLASS }
 329
 330 /**
 331  * @def EO_OP_FUNC_SENTINEL
 332  * A convenience macro to be used when populating the #Eo_Op_Func_Description
 333  * array. It must appear at the end of the ARRAY.
 334  */
 335 #define EO_OP_FUNC_SENTINEL { 0, NULL, EO_OP_TYPE_INVALID }
 336
 337 /**
 338  * @struct _Eo_Op_Description
 339  * This struct holds the description of a specific op.
 340  */
 341 struct _Eo_Op_Description
 342 {
 343    Eo_Op sub_op; /**< The sub_id of the op in it's class. */
 344    const char *name; /**< The name of the op. */
 345    const char *doc; /**< Explanation about the Op. */
 346    Eo_Op_Type op_type; /**< The type of the Op. */
 347 };
 348
 349 /**
 350  * @typedef Eo_Op_Description
 351  * A convenience typedef for #_Eo_Op_Description
 352  */
 353 typedef struct _Eo_Op_Description Eo_Op_Description;
 354
 355 /**
 356  * @struct _Eo_Class_Description
 357  * This struct holds the description of a class.
 358  * This description should be passed to eo_class_new.
 359  * Please use the #EO_CLASS_DESCRIPTION_OPS macro when populating it.
 360  */
 361 struct _Eo_Class_Description
 362 {
 363    const char *name; /**< The name of the class. */
 364    Eo_Class_Type type; /**< The type of the class. */
 365    struct {
 366         Eo_Op *base_op_id;
 367         const Eo_Op_Description *descs;
 368         size_t count;
 369    } ops; /**< The ops description, should be filled using #EO_CLASS_DESCRIPTION_OPS */
 370    const Eo_Event_Description **events; /**< The event descriptions for this class. */
 371    size_t data_size; /**< The size of data (private + protected + public) this class needs per object. */
 372    void (*constructor)(Eo *obj, void *class_data); /**< The constructor of the object. */
 373    void (*destructor)(Eo *obj, void *class_data); /**< The destructor of the object. */
 374    void (*class_constructor)(Eo_Class *klass); /**< The constructor of the class. */
 375    void (*class_destructor)(Eo_Class *klass); /**< The destructor of the class. */
 376 };
 377
 378 /**
 379  * @typedef Eo_Class_Description
 380  * A convenience typedef for #_Eo_Class_Description
 381  */
 382 typedef struct _Eo_Class_Description Eo_Class_Description;
 383
 384 /**
 385  * @def EO_CLASS_DESCRIPTION_OPS(base_op_id, op_descs, count)
 386  * An helper macro to help populating #Eo_Class_Description.
 387  * @param base_op_id A pointer to the base op id of the class.
 388  * @param op_descs the op descriptions array.
 389  * @param count the number of ops in the op descriptions array.
 390  */
 391 #define EO_CLASS_DESCRIPTION_OPS(base_op_id, op_descs, count) { base_op_id, op_descs, count }
 392
 393 /**
 394  * @def EO_OP_DESCRIPTION(op, doc)
 395  * An helper macro to help populating #Eo_Op_Description
 396  * @param sub_id The sub id of the op being described.
 397  * @param doc Additional doc for the op.
 398  * @see Eo_Op_Description
 399  * @see EO_OP_DESCRIPTION_CLASS
 400  * @see EO_OP_DESCRIPTION_CONST
 401  * @see EO_OP_DESCRIPTION_SENTINEL
 402  */
 403 #define EO_OP_DESCRIPTION(sub_id, doc) { sub_id, #sub_id, doc, EO_OP_TYPE_REGULAR }
 404
 405 /**
 406  * @def EO_OP_DESCRIPTION_CONST(op, doc)
 407  * An helper macro to help populating #Eo_Op_Description
 408  * This macro is the same as EO_OP_DESCRIPTION but indicates that the op's
 409  * implementation should not change the object.
 410  * @param sub_id The sub id of the op being described.
 411  * @param doc Additional doc for the op.
 412  * @see Eo_Op_Description
 413  * @see EO_OP_DESCRIPTION
 414  * @see EO_OP_DESCRIPTION_SENTINEL
 415  */
 416 #define EO_OP_DESCRIPTION_CONST(sub_id, doc) { sub_id, #sub_id, doc, EO_OP_TYPE_CONST }
 417
 418 /**
 419  * @def EO_OP_DESCRIPTION_CLASS(op, doc)
 420  * An helper macro to help populating #Eo_Op_Description
 421  * This macro is the same as EO_OP_DESCRIPTION but indicates that the op's
 422  * implementation is of type CLASS.
 423  * @param sub_id The sub id of the op being described.
 424  * @param doc Additional doc for the op.
 425  * @see Eo_Op_Description
 426  * @see EO_OP_DESCRIPTION
 427  * @see EO_OP_DESCRIPTION_SENTINEL
 428  */
 429 #define EO_OP_DESCRIPTION_CLASS(sub_id, doc) { sub_id, #sub_id, doc, EO_OP_TYPE_CLASS }
 430
 431 /**
 432  * @def EO_OP_DESCRIPTION_SENTINEL
 433  * An helper macro to help populating #Eo_Op_Description
 434  * Should be placed at the end of the array.
 435  * @see Eo_Op_Description
 436  * @see EO_OP_DESCRIPTION
 437  */
 438 #define EO_OP_DESCRIPTION_SENTINEL { 0, NULL, NULL, EO_OP_TYPE_INVALID }
 439
 440 /**
 441  * @brief Create a new class.
 442  * @param desc the class description to create the class with.
 443  * @param id a positive number to serve as the id of the class. 0 means dynamic allocation. The number of static Ids is limited and regular users should not use static ids.
 444  * @param parent the class to inherit from.
 445  * @param ... A NULL terminated list of extensions (interfaces, mixins and the classes of any composite objects).
 446  * @return The new class's handle on success, or NULL otherwise.
 447  *
 448  * You should use #EO_DEFINE_CLASS. It'll provide thread safety and other
 449  * features easily.
 450  *
 451  * @see #EO_DEFINE_CLASS
 452  */
 453 EAPI const Eo_Class *eo_class_new(const Eo_Class_Description *desc, Eo_Class_Id id, const Eo_Class *parent, ...);
 454
 455 /**
 456  * @brief Sets the OP functions for a class.
 457  * @param klass the class to set the functions to.
 458  * @param func_descs a NULL terminated array of #Eo_Op_Func_Description
 459  *
 460  * Should be called from within the class constructor.
 461  */
 462 EAPI void eo_class_funcs_set(Eo_Class *klass, const Eo_Op_Func_Description *func_descs);
 463
 464 /**
 465  * @brief Gets the name of the passed class.
 466  * @param klass the class to work on.
 467  * @return The class's name.
 468  *
 469  * @see eo_class_get()
 470  */
 471 EAPI const char *eo_class_name_get(const Eo_Class *klass);
 472
 473 /**
 474  * @}
 475  */
 476
 477 /**
 478  * @brief Init the eo subsystem
 479  * @return @c EINA_TRUE on success.
 480  *
 481  * @see eo_shutfown()
 482  */
 483 EAPI Eina_Bool eo_init(void);
 484
 485 /**
 486  * @brief Shutdown the eo subsystem
 487  * @return @c EINA_TRUE on success.
 488  *
 489  * @see eo_init()
 490  */
 491 EAPI Eina_Bool eo_shutdown(void);
 492
 493 /**
 494  * @def eo_do
 495  * A convenience wrapper around eo_do_internal()
 496  * @see eo_do_internal
 497  */
 498 #define eo_do(obj, ...) eo_do_internal(obj, EO_OP_TYPE_REGULAR, __VA_ARGS__, EO_NOOP)
 499
 500 /**
 501  * @def eo_query
 502  * Same as #eo_do but only for const ops.
 503  * @see eo_do
 504  */
 505 #define eo_query(obj, ...) eo_do_internal((Eo *) EO_TYPECHECK(const Eo *, obj), EO_OP_TYPE_CONST, __VA_ARGS__, EO_NOOP)
 506
 507 /**
 508  * @def eo_class_do
 509  * A convenience wrapper around eo_class_do_internal()
 510  * @see eo_class_do_internal
 511  */
 512 #define eo_class_do(klass, ...) eo_class_do_internal(klass, __VA_ARGS__, EO_NOOP)
 513
 514 /**
 515  * @brief Calls op functions of an object
 516  * @param obj The object to work on
 517  * @param op_type The type of the ops that are passed.
 518  * @param ... NULL terminated list of OPs and parameters.
 519  * @return @c EINA_TRUE on success.
 520  *
 521  * Use the helper macros, don't pass the parameters manually.
 522  * Use #eo_do instead of this function.
 523  *
 524  * @see #eo_do
 525  */
 526 EAPI Eina_Bool eo_do_internal(Eo *obj, Eo_Op_Type op_type, ...);
 527
 528 /**
 529  * @brief Calls op functions of a class.
 530  * @param klass The class to work on
 531  * @param ... NULL terminated list of OPs and parameters.
 532  * @return @c EINA_TRUE on success.
 533  *
 534  * Use the helper macros, don't pass the parameters manually.
 535  * Use #eo_do instead of this function.
 536  *
 537  * @see #eo_class_do
 538  */
 539 EAPI Eina_Bool eo_class_do_internal(const Eo_Class *klass, ...);
 540
 541 /**
 542  * @brief Calls the super function for the specific op.
 543  * @param obj The object to work on
 544  * @param ... list of parameters.
 545  * @return @c EINA_TRUE on success.
 546  *
 547  * Unlike eo_do() and eo_query(), this function only accepts one op.
 548  *
 549  * Use the helper macros, don't pass the parameters manually.
 550  *
 551  * Same as eo_do_super() just for const objects.
 552  *
 553  * @see #eo_query
 554  * @see eo_do_super()
 555  */
 556 #define eo_query_super(obj, ...) eo_do_super_internal((Eo *) EO_TYPECHECK(const Eo *, obj), EO_OP_TYPE_CONST, __VA_ARGS__)
 557
 558 /**
 559  * @brief Calls the super function for the specific op.
 560  * @param obj The object to work on
 561  * @param ... list of parameters.
 562  * @return @c EINA_TRUE on success.
 563  *
 564  * Unlike eo_do() and eo_query(), this function only accepts one op.
 565  *
 566  * @see #eo_do
 567  * @see eo_query_super()
 568  */
 569 #define eo_do_super(obj, ...) eo_do_super_internal(obj, EO_OP_TYPE_REGULAR, __VA_ARGS__)
 570
 571 /**
 572  * @brief Calls the super function for the specific op.
 573  * @param klass The klass to work on
 574  * @param ... list of parameters.
 575  * @return @c EINA_TRUE on success.
 576  *
 577  * Unlike eo_class_do(), this function only accepts one op.
 578  *
 579  * @see #eo_class_do
 580  */
 581 #define eo_class_do_super(klass, ...) eo_class_do_super_internal(klass, __VA_ARGS__)
 582
 583 /**
 584  * @brief Calls the super function for the specific op.
 585  * @param obj The object to work on
 586  * @param op_type The type of the ops that are passed.
 587  * @param op The wanted op.
 588  * @param ... list of parameters.
 589  * @return @c EINA_TRUE on success.
 590  *
 591  * Don't use this function, use the wrapping macros instead.
 592  *
 593  * @see #eo_do
 594  * @see #eo_do_super
 595  * @see #eo_query_super
 596  */
 597 EAPI Eina_Bool eo_do_super_internal(Eo *obj, Eo_Op_Type op_type, Eo_Op op, ...);
 598
 599 /**
 600  * @brief Calls the super function for the specific op.
 601  * @param klass The klass to work on
 602  * @param op The wanted op.
 603  * @param ... list of parameters.
 604  * @return @c EINA_TRUE on success.
 605  *
 606  * Don't use this function, use the wrapping macros instead.
 607  *
 608  * @see #eo_class_do
 609  * @see #eo_class_do_super
 610  */
 611 EAPI Eina_Bool eo_class_do_super_internal(const Eo_Class *klass, Eo_Op op, ...);
 612
 613 /**
 614  * @brief Gets the class of the object.
 615  * @param obj The object to work on
 616  * @return The object's class.
 617  *
 618  * @see eo_class_name_get()
 619  */
 620 EAPI const Eo_Class *eo_class_get(const Eo *obj);
 621
 622 /**
 623  * @brief Calls the super constructor of the object passed.
 624  * @param obj the object to work on.
 625  *
 626  * @see eo_destructor_super()
 627  */
 628 EAPI void eo_constructor_super(Eo *obj);
 629
 630 /**
 631  * @brief Calls the super destructor of the object passed.
 632  * @param obj the object to work on.
 633  *
 634  * @see eo_constructor_super()
 635  */
 636 EAPI void eo_destructor_super(Eo *obj);
 637
 638 /**
 639  * @def eo_error_set
 640  * @brief Notify eo that there was an error when constructing, destructing or calling a function of the object.
 641  * @param obj the object to work on.
 642  *
 643  * @see eo_error_get()
 644  */
 645 #define eo_error_set(obj) eo_error_set_internal(obj, __FILE__, __LINE__)
 646
 647 /* @cond 0 */
 648 EAPI void eo_error_set_internal(const Eo *obj, const char *file, int line);
 649 /* @endcond */
 650
 651 /**
 652  * @brief Create a new object.
 653  * @param klass the class of the object to create.
 654  * @param parent the parent to set to the object.
 655  * @return An handle to the new object on success, NULL otherwise.
 656  */
 657 EAPI Eo *eo_add(const Eo_Class *klass, Eo *parent);
 658
 659 /**
 660  * @brief Get the parent of an object
 661  * @param obj the object to get the parent of.
 662  * @return a pointer to the parent object.
 663  *
 664  * @see eo_parent_set()
 665  */
 666 EAPI Eo *eo_parent_get(const Eo *obj);
 667
 668 /**
 669  * @brief Set the parent of an object
 670  * @param obj the object to get the parent of.
 671  * @param parent the new parent.
 672  * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
 673  *
 674  * Parents keep references to their children so in order to delete objects
 675  * that have parents you need to set parent to NULL or use eo_del() that
 676  * does that for you (and also unrefs the object).
 677  *
 678  * @see eo_del()
 679  * @see eo_parent_get()
 680  */
 681 EAPI Eina_Bool eo_parent_set(Eo *obj, const Eo *parent);
 682
 683 /**
 684  * @brief Get a pointer to the data of an object for a specific class.
 685  * @param obj the object to work on.
 686  * @param klass the klass associated with the data.
 687  * @return a pointer to the data.
 688  */
 689 EAPI void *eo_data_get(const Eo *obj, const Eo_Class *klass);
 690
 691 /**
 692  * @brief Increment the object's reference count by 1.
 693  * @param obj the object to work on.
 694  * @return The object passed.
 695  *
 696  * It's very easy to get a refcount leak and start leaking memory because
 697  * of a forgotten unref or an extra ref. That is why there are eo_xref
 698  * and eo_xunref that will make debugging easier in such a case.
 699  * Therefor, these functions should only be used in small scopes, i.e at the
 700  * start of some section in which the object may get freed, or if you know
 701  * what you are doing.
 702  *
 703  * @see eo_unref()
 704  * @see eo_ref_get()
 705  */
 706 EAPI Eo *eo_ref(const Eo *obj);
 707
 708 /**
 709  * @brief Decrement the object's reference count by 1 and free it if needed.
 710  * @param obj the object to work on.
 711  *
 712  * @see eo_ref()
 713  * @see eo_ref_get()
 714  */
 715 EAPI void eo_unref(const Eo *obj);
 716
 717 /**
 718  * @brief Return the ref count of the object passed.
 719  * @param obj the object to work on.
 720  * @return the ref count of the object.
 721  *
 722  * @see eo_ref()
 723  * @see eo_unref()
 724  */
 725 EAPI int eo_ref_get(const Eo *obj);
 726
 727 /**
 728  * @brief Unrefs the object and reparents it to NULL.
 729  * @param obj the object to work on.
 730  *
 731  * Because eo_del() unrefs and reparents to NULL, it doesn't really delete the
 732  * object.
 733  *
 734  * @see eo_unref()
 735  * @see eo_parent_set()
 736  */
 737 EAPI void eo_del(const Eo *obj);
 738
 739 /**
 740  * @def eo_xref(obj, ref_obj)
 741  * Convenience macro around eo_xref_internal()
 742  * @see eo_xref()
 743  */
 744 #define eo_xref(obj, ref_obj) eo_xref_internal(obj, ref_obj, __FILE__, __LINE__)
 745
 746 /**
 747  * @brief Increment the object's reference count by 1 (and associate the ref with ref_obj)
 748  * @param obj the object to work on.
 749  * @param ref_obj the object that references obj.
 750  * @param file the call's filename.
 751  * @param line the call's line number.
 752  * @return The object passed (obj)
 753  *
 754  * People should not use this function, use #eo_xref instead.
 755  * A compile flag my make it and eobj_xunref() behave the same as eobj_ref()
 756  * and eobj_unref() respectively. So this should be used wherever possible.
 757  *
 758  * @see eo_xunref()
 759  */
 760 EAPI Eo *eo_xref_internal(Eo *obj, const Eo *ref_obj, const char *file, int line);
 761
 762 /**
 763  * @brief Decrement the object's reference count by 1 and free it if needed. Will free the ref associated with ref_obj).
 764  * @param obj the object to work on.
 765  * @param ref_obj the object that references obj.
 766  *
 767  * This function only enforces the checks for object association. I.e don't rely
 768  * on it. If such enforces are compiled out, this function behaves the same as
 769  * eo_unref().
 770  *
 771  * @see eo_xref_internal()
 772  */
 773 EAPI void eo_xunref(Eo *obj, const Eo *ref_obj);
 774
 775 /**
 776  * @addtogroup Eo_Composite_Objects Composite Objects.
 777  * @{
 778  */
 779
 780 /**
 781  * @brief Make an object a composite object of another.
 782  * @param obj the "parent" object.
 783  * @param comp_obj the object that will be used to composite obj.
 784  *
 785  * @see eo_composite_object_detach()
 786  * @see eo_composite_is()
 787  */
 788 EAPI void eo_composite_object_attach(Eo *obj, Eo *comp_obj);
 789
 790 /**
 791  * @brief Detach a composite object from another object.
 792  * @param obj the "parent" object.
 793  * @param comp_obj the object attached to obj.
 794  *
 795  * @see eo_composite_object_attach()
 796  * @see eo_composite_is()
 797  */
 798 EAPI void eo_composite_object_detach(Eo *obj, Eo *comp_obj);
 799
 800 /**
 801  * @brief Check if an object is a composite object.
 802  * @param comp_obj the object to be checked.
 803  * @return @c EINA_TRUE if it is, @c EINA_FALSE otherwise.
 804  *
 805  * @see eo_composite_object_attach()
 806  * @see eo_composite_object_detach()
 807  */
 808 EAPI Eina_Bool eo_composite_is(const Eo *comp_obj);
 809
 810 /**
 811  * @brief Enable or disable the manual free feature.
 812  * @param obj the object to work on.
 813  * @param manual_free indicates if the free is manual (EINA_TRUE) or automatic (EINA_FALSE).
 814  *
 815  * The developer is in charge to call the function eo_manual_free to free the memory allocated for this object.
 816  *
 817  * Do not use, unless you really know what you are doing. It's used by Evas
 818  * because evas wants to keep its private data available even after the object
 819  * is deleted. Setting this to true makes Eo destruct the object but not free
 820  * the private data or the object itself.
 821  *
 822  * @see eo_manual_free()
 823  */
 824 EAPI void eo_manual_free_set(Eo *obj, Eina_Bool manual_free);
 825
 826 /**
 827  * @brief Frees the object.
 828  * @param obj the object to work on.
 829  * This function must be called by the developer if the function
 830  * eo_manual_free_set has been called before with the parameter EINA_TRUE.
 831  * An error will be printed if this function is called when the manual
 832  * free option is not set to EINA_TRUE or the number of refs is not 0.
 833  *
 834  * @see eo_manual_free_set()
 835  */
 836 EAPI void eo_manual_free(Eo *obj);
 837
 838 /**
 839  * @}
 840  */
 841
 842 /**
 843  * @addtogroup Eo_Class_Base Eo's Base class.
 844  * @{
 845  */
 846
 847 /**
 848  * @def EO_BASE_CLASS
 849  * The class type for the Eo base class.
 850  */
 851 #define EO_BASE_CLASS eo_base_class_get()
 852 /**
 853  * @brief Use #EO_BASE_CLASS
 854  * @internal
 855  * */
 856 EAPI const Eo_Class *eo_base_class_get(void) EINA_CONST;
 857
 858 /**
 859  * @typedef eo_base_data_free_func
 860  * Data free func prototype.
 861  */
 862 typedef void (*eo_base_data_free_func)(void *);
 863
 864 /**
 865  * @def EO_BASE_CLASS_ID
 866  * #EO_BASE_CLASS 's class id.
 867  */
 868 #define EO_BASE_CLASS_ID 1
 869
 870 /**
 871  * @def EO_BASE_BASE_ID
 872  * #EO_BASE_CLASS 's base id.
 873  */
 874 #define EO_BASE_BASE_ID EO_CLASS_ID_TO_BASE_ID(EO_BASE_CLASS_ID)
 875
 876 enum {
 877      EO_BASE_SUB_ID_DATA_SET,
 878      EO_BASE_SUB_ID_DATA_GET,
 879      EO_BASE_SUB_ID_DATA_DEL,
 880      EO_BASE_SUB_ID_WREF_ADD,
 881      EO_BASE_SUB_ID_WREF_DEL,
 882      EO_BASE_SUB_ID_EVENT_CALLBACK_PRIORITY_ADD,
 883      EO_BASE_SUB_ID_EVENT_CALLBACK_DEL,
 884      EO_BASE_SUB_ID_EVENT_CALLBACK_CALL,
 885      EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_ADD,
 886      EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_DEL,
 887      EO_BASE_SUB_ID_EVENT_FREEZE,
 888      EO_BASE_SUB_ID_EVENT_THAW,
 889      EO_BASE_SUB_ID_EVENT_FREEZE_GET,
 890      EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE,
 891      EO_BASE_SUB_ID_EVENT_GLOBAL_THAW,
 892      EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE_GET,
 893      EO_BASE_SUB_ID_LAST
 894 };
 895
 896 /**
 897  * @def EO_BASE_ID(sub_id)
 898  * Helper macro to get the full Op ID out of the sub_id for EO_BASE.
 899  * @param sub_id the sub id inside EO_BASE.
 900  */
 901 #define EO_BASE_ID(sub_id) (EO_BASE_BASE_ID + (sub_id))
 902
 903 /**
 904  * @def eo_base_data_set(key, data, free_func)
 905  * Set generic data to object.
 906  * @param[in] key the key associated with the data
 907  * @param[in] data the data to set.
 908  * @param[in] free_func the func to free data with (NULL means "do nothing").
 909  *
 910  * @see #eo_base_data_get
 911  * @see #eo_base_data_del
 912  */
 913 #define eo_base_data_set(key, data, free_func) EO_BASE_ID(EO_BASE_SUB_ID_DATA_SET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(const void *, data), EO_TYPECHECK(eo_base_data_free_func, free_func)
 914
 915 /**
 916  * @def eo_base_data_get(key, data)
 917  * Get generic data from object.
 918  * @param[in] key the key associated with the data
 919  * @param[out] data the data for the key
 920  *
 921  * @see #eo_base_data_set
 922  * @see #eo_base_data_del
 923  */
 924 #define eo_base_data_get(key, data) EO_BASE_ID(EO_BASE_SUB_ID_DATA_GET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(void **, data)
 925
 926 /**
 927  * @def eo_base_data_del(key)
 928  * Del generic data from object.
 929  * @param[in] key the key associated with the data
 930  *
 931  * @see #eo_base_data_set
 932  * @see #eo_base_data_get
 933  */
 934 #define eo_base_data_del(key) EO_BASE_ID(EO_BASE_SUB_ID_DATA_DEL), EO_TYPECHECK(const char *, key)
 935
 936 /**
 937  * @def eo_wref_add
 938  * @brief Add a new weak reference to obj.
 939  * @param wref The pointer to use for the weak ref.
 940  *
 941  * This function registers the object handle pointed by wref to obj so when
 942  * obj is deleted it'll be updated to NULL. This functions should be used
 943  * when you want to keep track of an object in a safe way, but you don't want
 944  * to prevent it from being freed.
 945  *
 946  * @see #eo_wref_del
 947  */
 948 #define eo_wref_add(wref) EO_BASE_ID(EO_BASE_SUB_ID_WREF_ADD), EO_TYPECHECK(Eo **, wref)
 949
 950 /**
 951  * @def eo_wref_del
 952  * @brief Delete the weak reference passed.
 953  * @param wref the weak reference to free.
 954  *
 955  * @see #eo_wref_add
 956  */
 957 #define eo_wref_del(wref) EO_BASE_ID(EO_BASE_SUB_ID_WREF_DEL), EO_TYPECHECK(Eo **, wref)
 958
 959 /**
 960  * @def eo_wref_del_safe
 961  * @brief Delete the weak reference passed.
 962  * @param wref the weak reference to free.
 963  *
 964  * Same as eo_wref_del(), with the different that it's not called from eobj_do()
 965  * so you don't need to check if *wref is not NULL.
 966  *
 967  * @see #eo_wref_del
 968  */
 969 #define eo_wref_del_safe(wref) \
 970    do { \
 971         if (*wref) eo_do(*wref, eo_wref_del(wref)); \
 972    } while (0)
 973
 974 /**
 975  * @addtogroup Eo_Events Eo's Event Handling
 976  * @{
 977  */
 978
 979 /**
 980  * @def EO_CALLBACK_PRIORITY_BEFORE
 981  * Slightly more prioritized than default.
 982  */
 983 #define EO_CALLBACK_PRIORITY_BEFORE -100
 984 /**
 985  * @def EO_CALLBACK_PRIORITY_DEFAULT
 986  * Default callback priority level
 987  */
 988 #define EO_CALLBACK_PRIORITY_DEFAULT 0
 989 /**
 990  * @def EO_CALLBACK_PRIORITY_AFTER
 991  * Slightly less prioritized than default.
 992  */
 993 #define EO_CALLBACK_PRIORITY_AFTER 100
 994
 995 /**
 996  * @typedef Eo_Callback_Priority
 997  *
 998  * Callback priority value. Range is -32k - 32k. The lower the number, the
 999  * higher the priority.
1000  *
1001  * @see EO_CALLBACK_PRIORITY_AFTER
1002  * @see EO_CALLBACK_PRIORITY_BEFORE
1003  * @see EO_CALLBACK_PRIORITY_DEFAULT
1004  */
1005 typedef short Eo_Callback_Priority;
1006
1007 /**
1008  * @def EO_CALLBACK_STOP
1009  * Stop calling callbacks for the even of which the callback was called for.
1010  * @see EO_CALLBACK_CONTINUE
1011  */
1012 #define EO_CALLBACK_STOP EINA_FALSE
1013
1014 /**
1015  * @def EO_CALLBACK_CONTINUE
1016  * Continue calling callbacks for the even of which the callback was called for.
1017  * @see EO_CALLBACK_STOP
1018  */
1019 #define EO_CALLBACK_CONTINUE EINA_TRUE
1020
1021 /**
1022  * @typedef Eo_Event_Cb
1023  *
1024  * An event callback prototype.
1025  *
1026  * @param data The user data registered with the callback.
1027  * @param obj The object which initiated the event.
1028  * @param desc The event's description.
1029  * @param event_info additional data passed with the event.
1030  * @return #EO_CALLBACK_STOP to stop calling additional callbacks for the event, #EO_CALLBACK_CONTINUE to continue.
1031  */
1032 typedef Eina_Bool (*Eo_Event_Cb)(void *data, Eo *obj, const Eo_Event_Description *desc, void *event_info);
1033
1034 /**
1035  * @def eo_event_callback_forwarder_add
1036  * @brief Add an event callback forwarder for an event and an object.
1037  * @param[in] desc The description of the event to listen to.
1038  * @param[in] new_obj The object to emit events from.
1039  *
1040  * @see eo_event_callback_forwarder_del()
1041  */
1042 #define eo_event_callback_forwarder_add(desc, new_obj) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_ADD), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo *, new_obj)
1043
1044 /**
1045  * @def eo_event_callback_forwarder_del
1046  * @brief Remove an event callback forwarder for an event and an object.
1047  * @param[in] desc The description of the event to listen to.
1048  * @param[in] new_obj The object to emit events from.
1049  *
1050  * @see eo_event_callback_forwarder_add()
1051  */
1052 #define eo_event_callback_forwarder_del(desc, new_obj) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_DEL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo *, new_obj)
1053
1054 /**
1055  * @def eo_event_freeze
1056  * @brief freeze events of object.
1057  *
1058  * Prevents event callbacks from being called for the object.
1059  *
1060  * @see #eo_event_thaw
1061  */
1062 #define eo_event_freeze() EO_BASE_ID(EO_BASE_SUB_ID_EVENT_FREEZE)
1063
1064 /**
1065  * @def eo_event_thaw
1066  * @brief thaw events of object.
1067  *
1068  * Lets event callbacks be called for the object.
1069  *
1070  * @see #eo_event_freeze
1071  */
1072 #define eo_event_thaw() EO_BASE_ID(EO_BASE_SUB_ID_EVENT_THAW)
1073
1074 /**
1075  * @def eo_event_freeze_get
1076  * @brief return freeze events of object.
1077  *
1078  * @param[out] fcount The event freeze count of the object.
1079  *
1080  * Return event freeze count.
1081  *
1082  * @see #eo_event_freeze
1083  * @see #eo_event_thaw
1084  */
1085 #define eo_event_freeze_get(fcount) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_FREEZE_GET), EO_TYPECHECK(int *, fcount)
1086
1087 /**
1088  * @def eo_event_global_freeze
1089  * @brief freeze events of object.
1090  *
1091  * Prevents event callbacks from being called for the object.
1092  *
1093  * @see #eo_event_freeze
1094  * @see #eo_event_global_thaw
1095  */
1096 #define eo_event_global_freeze() EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE)
1097
1098 /**
1099  * @def eo_event_global_thaw
1100  * @brief thaw events of object.
1101  *
1102  * Lets event callbacks be called for the object.
1103  *
1104  * @see #eo_event_thaw
1105  * @see #eo_event_global_freeze
1106  */
1107 #define eo_event_global_thaw() EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_THAW)
1108
1109 /**
1110  * @def eo_event_global_freeze_get
1111  * @brief return freeze events of object.
1112  *
1113  * @param[out] fcount The event freeze count of the object.
1114  *
1115  * Return event freeze count.
1116  *
1117  * @see #eo_event_freeze_get
1118  * @see #eo_event_global_freeze
1119  * @see #eo_event_global_thaw
1120  */
1121 #define eo_event_global_freeze_get(fcount) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE_GET), EO_TYPECHECK(int *, fcount)
1122
1123 /**
1124  * @def eo_event_callback_add(obj, desc, cb, data)
1125  * Add a callback for an event.
1126  * @param[in] desc The description of the event to listen to.
1127  * @param[in] cb the callback to call.
1128  * @param[in] data additional data to pass to the callback.
1129  *
1130  * callbacks of the same priority are called in reverse order of creation.
1131  *
1132  * @see eo_event_callback_priority_add()
1133  */
1134 #define eo_event_callback_add(desc, cb, data) \
1135    eo_event_callback_priority_add(desc, \
1136          EO_CALLBACK_PRIORITY_DEFAULT, cb, data)
1137
1138 /**
1139  * @def eo_event_callback_priority_add
1140  * @brief Add a callback for an event with a specific priority.
1141  * @param[in] desc The description of the event to listen to.
1142  * @param[in] priority The priority of the callback.
1143  * @param[in] cb the callback to call.
1144  * @param[in] data additional data to pass to the callback.
1145  *
1146  * callbacks of the same priority are called in reverse order of creation.
1147  *
1148  * @see #eo_event_callback_add
1149  */
1150 #define eo_event_callback_priority_add(desc, priority, cb, data) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_PRIORITY_ADD), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo_Callback_Priority, priority), EO_TYPECHECK(Eo_Event_Cb, cb), EO_TYPECHECK(const void *, data)
1151
1152
1153 /**
1154  * @def eo_event_callback_del
1155  * @brief Del a callback with a specific data associated to it for an event.
1156  * @param[in] desc The description of the event to listen to.
1157  * @param[in] func the callback to delete.
1158  * @param[in] user_data The data to compare.
1159  *
1160  */
1161 #define eo_event_callback_del(desc, func, user_data) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_DEL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo_Event_Cb, func), EO_TYPECHECK(const void *, user_data)
1162
1163 /**
1164  * @def eo_event_callback_call
1165  * @brief Call the callbacks for an event of an object.
1166  * @param[in] desc The description of the event to call.
1167  * @param[in] event_info Extra event info to pass to the callbacks.
1168  * @param[out] aborted @c EINA_TRUE if one of the callbacks aborted the call, @c EINA_FALSE otherwise.
1169  */
1170 #define eo_event_callback_call(desc, event_info, aborted) EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_CALL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(const void *, event_info), EO_TYPECHECK(Eina_Bool *, aborted)
1171
1172 /**
1173  * @}
1174  */
1175
1176 /**
1177  * @var _EO_EV_CALLBACK_ADD
1178  * see EO_EV_CALLBACK_ADD
1179  */
1180 EAPI extern const Eo_Event_Description _EO_EV_CALLBACK_ADD;
1181
1182 /**
1183  * @def EO_EV_CALLBACK_ADD
1184  * The event description (of type #Eo_Event_Description) for
1185  * The "Callback listener added" event.
1186  */
1187 #define EO_EV_CALLBACK_ADD (&(_EO_EV_CALLBACK_ADD))
1188
1189 /**
1190  * @var _EO_EV_CALLBACK_DEL
1191  * see EO_EV_CALLBACK_DEL
1192  */
1193 EAPI extern const Eo_Event_Description _EO_EV_CALLBACK_DEL;
1194
1195 /**
1196  * @def EO_EV_CALLBACK_DEL
1197  * The event description (of type #Eo_Event_Description) for
1198  * The "Callback listener deleted" event.
1199  */
1200 #define EO_EV_CALLBACK_DEL (&(_EO_EV_CALLBACK_DEL))
1201
1202 /**
1203  * @var _EO_EV_DEL
1204  * see #EO_EV_DEL
1205  */
1206 EAPI extern const Eo_Event_Description _EO_EV_DEL;
1207
1208 /**
1209  * @def EO_EV_DEL
1210  * Object is being deleted.
1211  */
1212 #define EO_EV_DEL (&(_EO_EV_DEL))
1213
1214 /**
1215  * @}
1216  */
1217
1218 /**
1219  * @}
1220  */
1221
1222 #ifdef __cplusplus
1223 }
1224 #endif
1225
1226 #endif