From 3e080c5eb45da8ea2534c3186e9a86e87ce67883 Mon Sep 17 00:00:00 2001 From: Gustavo Lima Chaves Date: Tue, 31 Jul 2012 22:05:12 +0000 Subject: [PATCH] [elm] Plug now inheritable. SVN revision: 74672 --- src/lib/elm_plug.c | 60 +++++++----------- src/lib/elm_widget_plug.h | 157 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 178 insertions(+), 39 deletions(-) create mode 100644 src/lib/elm_widget_plug.h diff --git a/src/lib/elm_plug.c b/src/lib/elm_plug.c index 0a065fe..a12f48b 100644 --- a/src/lib/elm_plug.c +++ b/src/lib/elm_plug.c @@ -1,41 +1,8 @@ #include #include "elm_priv.h" +#include "elm_widget_plug.h" -static const char PLUG_SMART_NAME[] = "elm_plug"; - -#define ELM_PLUG_DATA_GET(o, sd) \ - Elm_Plug_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_PLUG_DATA_GET_OR_RETURN(o, ptr) \ - ELM_PLUG_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_PLUG_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_PLUG_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_PLUG_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), PLUG_SMART_NAME, __func__)) \ - return - -typedef struct _Elm_Plug_Smart_Data Elm_Plug_Smart_Data; - -struct _Elm_Plug_Smart_Data -{ - Elm_Widget_Smart_Data base; /* base widget smart data as - * first member obligatory, as - * we're inheriting from it */ -}; +EAPI const char ELM_PLUG_SMART_NAME[] = "elm_plug"; static const char SIG_CLICKED[] = "clicked"; static const Evas_Smart_Cb_Description _smart_callbacks[] = { @@ -44,7 +11,7 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = { }; EVAS_SMART_SUBCLASS_NEW - (PLUG_SMART_NAME, _elm_plug, Elm_Widget_Smart_Class, + (ELM_PLUG_SMART_NAME, _elm_plug, Elm_Plug_Smart_Class, Elm_Widget_Smart_Class, elm_widget_smart_class_get, _smart_callbacks); static void @@ -104,11 +71,26 @@ _elm_plug_smart_add(Evas_Object *obj) } static void -_elm_plug_smart_set_user(Elm_Widget_Smart_Class *sc) +_elm_plug_smart_set_user(Elm_Plug_Smart_Class *sc) { - sc->base.add = _elm_plug_smart_add; + ELM_WIDGET_CLASS(sc)->base.add = _elm_plug_smart_add; + + ELM_WIDGET_CLASS(sc)->theme = _elm_plug_smart_theme; +} + +EAPI const Elm_Plug_Smart_Class * +elm_plug_smart_class_get(void) +{ + static Elm_Plug_Smart_Class _sc = + ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION(ELM_PLUG_SMART_NAME); + static const Elm_Plug_Smart_Class *class = NULL; + + if (class) return class; + + _elm_plug_smart_set(&_sc); + class = &_sc; - sc->theme = _elm_plug_smart_theme; + return class; } EAPI Evas_Object * diff --git a/src/lib/elm_widget_plug.h b/src/lib/elm_widget_plug.h new file mode 100644 index 0000000..cc61957 --- /dev/null +++ b/src/lib/elm_widget_plug.h @@ -0,0 +1,157 @@ +#ifndef ELM_WIDGET_PLUG_H +#define ELM_WIDGET_PLUG_H + +/** + * @addtogroup Widget + * @{ + * + * @section elm-plug-class The Elementary Plug Class + * + * Elementary, besides having the @ref Plug widget, exposes its + * foundation -- the Elementary Plug Class -- in order to create other + * widgets which are a plug with some more logic on top. + */ + +/** + * @def ELM_PLUG_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Plug_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PLUG_CLASS(x) ((Elm_Plug_Smart_Class *)x) + +/** + * @def ELM_PLUG_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Plug_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PLUG_DATA(x) ((Elm_Plug_Smart_Data *)x) + +/** + * @def ELM_PLUG_SMART_CLASS_VERSION + * + * Current version for Elementary plug @b base smart class, a value + * which goes to _Elm_Plug_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_PLUG_SMART_CLASS_VERSION 1 + +/** + * @def ELM_PLUG_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Plug_Smart_Class structure, with + * @c NULL values on its specific fields. + * + * @param smart_class_init initializer to use for the "base" field + * (#Evas_Smart_Class). + * + * @see EVAS_SMART_CLASS_INIT_NULL + * @see EVAS_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PLUG_SMART_CLASS_INIT_NULL + * @see ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_PLUG_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_PLUG_SMART_CLASS_VERSION} + +/** + * @def ELM_PLUG_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Plug_Smart_Class structure. + * + * @see ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PLUG_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PLUG_SMART_CLASS_INIT_NULL \ + ELM_PLUG_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Plug_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_PLUG_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Plug_Smart_Class (base field) + * to the latest #ELM_PLUG_SMART_CLASS_VERSION and name it to the + * specific value. + * + * It will keep a reference to the name field as a "const char *", + * i.e., the name must be available while the structure is + * used (hint: static or global variable!) and must not be modified. + * + * @see ELM_PLUG_SMART_CLASS_INIT_NULL + * @see ELM_PLUG_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_PLUG_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary plug base smart class. This inherits directly from + * #Elm_Widget_Smart_Class and is meant to build widgets extending the + * behavior of a plug. + * + * All of the functions listed on @ref Plug namespace will work for + * objects deriving from #Elm_Plug_Smart_Class. + */ +typedef struct _Elm_Plug_Smart_Class +{ + Elm_Widget_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Plug_Smart_Class; + +/** + * Base widget smart data extended with plug instance data. + */ +typedef struct _Elm_Plug_Smart_Data Elm_Plug_Smart_Data; +struct _Elm_Plug_Smart_Data +{ + Elm_Widget_Smart_Data base; /* base widget smart data as + * first member obligatory, as + * we're inheriting from it */ +}; +/** + * @} + */ + +EAPI extern const char ELM_PLUG_SMART_NAME[]; +EAPI const Elm_Plug_Smart_Class *elm_plug_smart_class_get(void); + +#define ELM_PLUG_DATA_GET(o, sd) \ + Elm_Plug_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_PLUG_DATA_GET_OR_RETURN(o, ptr) \ + ELM_PLUG_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_PLUG_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_PLUG_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_PLUG_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_PLUG_SMART_NAME, __func__)) \ + return + +#endif -- 2.7.4