From d940ffe1f6bde1a3cf524afccd9e810e8cd1fff9 Mon Sep 17 00:00:00 2001 From: Changgyu Choi Date: Tue, 18 Mar 2025 10:22:19 +0900 Subject: [PATCH] Deprecated component-based-app efl api Since Tizen 10.0, EFL will be deprecated. component-based-app that depend on the efl api will also be deprecated. Change-Id: Idc2b1473cb2d7dc992b555f54b988876c74f2fa1 Signed-off-by: Changgyu Choi --- .../efl_base/api/component_based_app.h | 15 ++++++++---- .../efl_base/api/frame_component.h | 23 ++++++++++++++++-- .../efl_base/api/service_component.h | 14 +++++++++++ component_based/efl_base/stub.cc | 24 +++++++++++++++++++ doc/appfw_component_based_application_doc.h | 6 ++--- 5 files changed, 73 insertions(+), 9 deletions(-) diff --git a/component_based/efl_base/api/component_based_app.h b/component_based/efl_base/api/component_based_app.h index 660003f..d4b53c8 100644 --- a/component_based/efl_base/api/component_based_app.h +++ b/component_based/efl_base/api/component_based_app.h @@ -33,6 +33,7 @@ extern "C" { /** + * @deprecated Deprecated since 10.0. * @brief Called when the application starts. * @details The callback function is called before the main loop of the application starts. * In this callback, you can initialize resources which can be shared among component instances. @@ -49,6 +50,7 @@ extern "C" { typedef component_class_h (*component_based_app_create_cb)(void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the main loop of the application exits. * @details This callback function is called once after the main loop of the application exits. * You should release the resources of the application in this function. @@ -60,6 +62,7 @@ typedef component_class_h (*component_based_app_create_cb)(void *user_data); typedef void (*component_based_app_terminate_cb)(void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief The structure for lifecycle of a component based application. * @since_tizen 5.5 */ @@ -69,6 +72,7 @@ typedef struct { } component_based_app_lifecycle_callback_s; /** + * @deprecated Deprecated since 10.0. * @brief Runs the main loop of the application until component_based_app_exit() is called. * @since_tizen 5.5 * @@ -84,9 +88,10 @@ typedef struct { */ int component_based_app_main(int argc, char **argv, component_based_app_lifecycle_callback_s *callback, - void *user_data); + void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 10.0. * @brief Exits the main loop of the application. * @since_tizen 5.5 * @@ -94,9 +99,10 @@ int component_based_app_main(int argc, char **argv, * otherwise a negative error value * @retval #APP_ERROR_NONE Successful */ -int component_based_app_exit(void); +int component_based_app_exit(void) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 10.0. * @brief Adds a new frame component to @a comp_class. * @details Adds a new frame component with @a comp_id to @a comp_class. * If @a comp_class is null, the platform creates a #component_class_h and adds a new frame component with @a comp_id and then return the #component_class_h. @@ -119,9 +125,10 @@ component_class_h component_based_app_add_frame_component( component_class_h comp_class, const char *comp_id, frame_component_lifecycle_callback_s *callback, - void *user_data); + void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 10.0. * @brief Adds a service component to @a comp_class. * @details Adds a new service component with @a comp_id to @a comp_class. * If @a comp_class is null, the platform creates a #component_class_h and adds a new service component with @a comp_id and then return the #component_class_h. @@ -144,7 +151,7 @@ component_class_h component_based_app_add_service_component( component_class_h comp_class, const char *comp_id, service_component_lifecycle_callback_s *callback, - void *user_data); + void *user_data) TIZEN_DEPRECATED_API; /** * @} diff --git a/component_based/efl_base/api/frame_component.h b/component_based/efl_base/api/frame_component.h index e9c9f02..4e0b97f 100644 --- a/component_based/efl_base/api/frame_component.h +++ b/component_based/efl_base/api/frame_component.h @@ -33,6 +33,7 @@ extern "C" { /** + * @deprecated Deprecated since 10.0. * @brief Called when the frame component instance is created. * @details The returned Evas_Object MUST NOT be released using evas_object_del(). The platform frees the window when the frame component instance is destroyed. * @since_tizen 5.5 @@ -50,6 +51,7 @@ typedef Evas_Object *(*frame_component_create_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the frame component instance is started. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -68,6 +70,7 @@ typedef void (*frame_component_start_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the frame component becomes visible. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -80,6 +83,7 @@ typedef void (*frame_component_resume_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the frame component becomes invisible. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -92,6 +96,7 @@ typedef void (*frame_component_pause_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called before the frame component instance is stopped. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -104,6 +109,7 @@ typedef void (*frame_component_stop_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called before the frame component instance is destroyed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -116,6 +122,7 @@ typedef void (*frame_component_destroy_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called after the content information of the frame component instance is restored. * @since_tizen 5.5 * @remarks The @a content should not be released. The @a content can be used only in the callback. @@ -131,6 +138,7 @@ typedef void (*frame_component_restore_content_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called before the content information of the frame component instance is saved. * @since_tizen 5.5 * @remarks The @a content should not be released. The @a content can be used only in the callback. @@ -146,6 +154,7 @@ typedef void (*frame_component_save_content_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when another application sends a launch request to the component. * @details Before calling frame_component_start_cb(), this callback function is called. * @since_tizen 5.5 @@ -170,6 +179,7 @@ typedef void (*frame_component_action_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the device orientation is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -184,6 +194,7 @@ typedef void (*frame_component_device_orientation_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the system language is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -199,6 +210,7 @@ typedef void (*frame_component_language_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the system region format is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -214,6 +226,7 @@ typedef void (*frame_component_region_format_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the battery status is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -228,6 +241,7 @@ typedef void (*frame_component_low_battery_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the memory status is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -242,6 +256,7 @@ typedef void (*frame_component_low_memory_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the suspended state of the frame component is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -256,6 +271,7 @@ typedef void (*frame_component_suspended_state_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the time zone of the frame component is changed. * @details An application can obtain a changed time zone (e.g., "+9:00") and a time zone id (e.g., "Asia/Seoul"). * @since_tizen 8.0 @@ -274,6 +290,7 @@ typedef void (*frame_component_time_zone_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief The structure type containing the set of callback functions for lifecycle of a frame component instance. * @since_tizen 5.5 */ @@ -297,6 +314,7 @@ typedef struct { } frame_component_lifecycle_callback_s; /** + * @deprecated Deprecated since 10.0. * @brief Gets the display status. * @since_tizen 5.5 * @@ -311,9 +329,10 @@ typedef struct { * @retval #COMPONENT_ERROR_INVALID_CONTEXT The display is in an unknown state. */ int frame_component_get_display_status(component_h context, - component_display_status_e *display_status); + component_display_status_e *display_status) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 10.0. * @brief Gets an Evas object for the frame component. * @since_tizen 5.5 * @remarks The @c window MUST NOT be released using evas_object_del(). @@ -328,7 +347,7 @@ int frame_component_get_display_status(component_h context, * @retval #COMPONENT_ERROR_INVALID_PARAMETER Invalid parameter */ int frame_component_get_window(component_h context, - Evas_Object **window); + Evas_Object **window) TIZEN_DEPRECATED_API; /** diff --git a/component_based/efl_base/api/service_component.h b/component_based/efl_base/api/service_component.h index 95a2f9b..0c0b19e 100644 --- a/component_based/efl_base/api/service_component.h +++ b/component_based/efl_base/api/service_component.h @@ -34,6 +34,7 @@ extern "C" { /** + * @deprecated Deprecated since 10.0. * @brief Called when the service component instance is created. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -49,6 +50,7 @@ typedef bool(*service_component_create_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the service component instance is started. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -67,6 +69,7 @@ typedef void (*service_component_start_command_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called before the service component instance is destroyed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -79,6 +82,7 @@ typedef void (*service_component_destroy_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called after the content information of the service component instance is restored. * @since_tizen 5.5 * @remarks The @a content should not be released. The @a content can be used only in the callback. @@ -94,6 +98,7 @@ typedef void (*service_component_restore_content_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called before the content information of the service component instance is saved. * @since_tizen 5.5 * @remarks The @a content should not be released. The @a content can be used only in the callback. @@ -109,6 +114,7 @@ typedef void (*service_component_save_content_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when another application sends a launch request to the component. * @details Before calling service_component_start_command_cb(), this callback function is called. * @since_tizen 5.5 @@ -133,6 +139,7 @@ typedef void (*service_component_action_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the device orientation is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -147,6 +154,7 @@ typedef void (*service_component_device_orientation_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the system language is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -162,6 +170,7 @@ typedef void (*service_component_language_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the system region format is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -177,6 +186,7 @@ typedef void (*service_component_region_format_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the battery status is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -191,6 +201,7 @@ typedef void (*service_component_low_battery_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the memory status is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -205,6 +216,7 @@ typedef void (*service_component_low_memory_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the suspended state of the service component is changed. * @since_tizen 5.5 * @remarks The @a context should not be released. The @a context can be used only in the callback. @@ -219,6 +231,7 @@ typedef void (*service_component_suspended_state_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief Called when the time zone of the service component is changed. * @details An application can obtain a changed time zone (e.g., "+9:00") and a time zone id (e.g., "Asia/Seoul"). * @since_tizen 8.0 @@ -237,6 +250,7 @@ typedef void (*service_component_time_zone_changed_cb)( void *user_data); /** + * @deprecated Deprecated since 10.0. * @brief The structure type containing the set of callback functions for lifecycle of a service component instance. * @since_tizen 5.5 */ diff --git a/component_based/efl_base/stub.cc b/component_based/efl_base/stub.cc index e3c3503..8f818a4 100644 --- a/component_based/efl_base/stub.cc +++ b/component_based/efl_base/stub.cc @@ -436,6 +436,10 @@ class StubServiceComponent : public ServiceComponent { extern "C" EXPORT_API int component_based_app_main(int argc, char** argv, component_based_app_lifecycle_callback_s *callback, void* user_data) { + LOGW( + "DEPRECATION WARNING: %s() is deprecated and will be removed from future " + "release.", + __FUNCTION__); if (argc < 1 || argv == nullptr || !callback || !callback->create) { LOGE("Invalid parameter"); return APP_ERROR_INVALID_PARAMETER; @@ -456,6 +460,10 @@ extern "C" EXPORT_API int component_based_app_main(int argc, char** argv, } extern "C" EXPORT_API int component_based_app_exit(void) { + LOGW( + "DEPRECATION WARNING: %s() is deprecated and will be removed from future " + "release.", + __FUNCTION__); auto& inst = ::StubApplication::GetInst(); inst.Exit(); return APP_ERROR_NONE; @@ -467,6 +475,10 @@ component_based_app_add_frame_component( const char* comp_id, frame_component_lifecycle_callback_s* callback, void* user_data) { + LOGW( + "DEPRECATION WARNING: %s() is deprecated and will be removed from future " + "release.", + __FUNCTION__); if (comp_id == nullptr || callback == nullptr) { LOGE("Invalid parameter"); set_last_result(APP_ERROR_INVALID_PARAMETER); @@ -512,6 +524,10 @@ component_based_app_add_service_component( const char* comp_id, service_component_lifecycle_callback_s* callback, void* user_data) { + LOGW( + "DEPRECATION WARNING: %s() is deprecated and will be removed from future " + "release.", + __FUNCTION__); if (comp_id == nullptr || callback == nullptr) { LOGE("Invalid parameter"); set_last_result(APP_ERROR_INVALID_PARAMETER); @@ -553,6 +569,10 @@ component_based_app_add_service_component( extern "C" EXPORT_API int frame_component_get_display_status( component_h context, component_display_status_e* display_status) { + LOGW( + "DEPRECATION WARNING: %s() is deprecated and will be removed from future " + "release.", + __FUNCTION__); if (context == nullptr || display_status == nullptr) { LOGE("Invalid parameter"); return COMPONENT_ERROR_INVALID_PARAMETER; @@ -582,6 +602,10 @@ extern "C" EXPORT_API int frame_component_get_display_status( extern "C" EXPORT_API int frame_component_get_window( component_h context, Evas_Object** window) { + LOGW( + "DEPRECATION WARNING: %s() is deprecated and will be removed from future " + "release.", + __FUNCTION__); if (context == nullptr || window == nullptr) { LOGE("Invalid parameter"); return COMPONENT_ERROR_INVALID_PARAMETER; diff --git a/doc/appfw_component_based_application_doc.h b/doc/appfw_component_based_application_doc.h index 9ad45bc..bd459f7 100755 --- a/doc/appfw_component_based_application_doc.h +++ b/doc/appfw_component_based_application_doc.h @@ -18,7 +18,7 @@ #define __TIZEN_APPFW_COMPONENT_BASED_APPLICATION_DOC_H__ /** - * @defgroup COMPONENT_BASED_APPLICATION_MODULE Component Based Application + * @defgroup COMPONENT_BASED_APPLICATION_MODULE Component Based Application (Deprecated) * @ingroup CAPI_APPLICATION_FRAMEWORK * @brief Component based application API. * @@ -67,7 +67,7 @@ */ /** - * @defgroup COMPONENT_BASED_FRAME_COMPONENT_MODULE Frame Component + * @defgroup COMPONENT_BASED_FRAME_COMPONENT_MODULE Frame Component (Deprecated) * @ingroup COMPONENT_BASED_APPLICATION_MODULE * @brief The @ref COMPONENT_BASED_FRAME_COMPONENT_MODULE API provides functions for handling Frame Component state changes or system events, and get information about the Frame Component * @@ -168,7 +168,7 @@ */ /** - * @defgroup COMPONENT_BASED_SERVICE_COMPONENT_MODULE Service Component + * @defgroup COMPONENT_BASED_SERVICE_COMPONENT_MODULE Service Component (Deprecated) * @ingroup COMPONENT_BASED_APPLICATION_MODULE * @brief The @ref COMPONENT_BASED_SERVICE_COMPONENT_MODULE API provides functions for handling Service Component state changes or system events. * -- 2.34.1