From 33cbe2a5c488ba179d1defef87a4bb959c95bd32 Mon Sep 17 00:00:00 2001
From: Michal Pawluk <m.pawluk@samsung.com>
Date: Mon, 10 Aug 2015 13:44:29 +0200
Subject: [PATCH] [SAMPLE APP][APP-COMMON] Application initialization section
 added

Change-Id: I9012f89d900635a25b8e019f9359878af3441814
Signed-off-by: Michal Pawluk <m.pawluk@samsung.com>
---
 .../html/mobile_n/appcommon_sd_mn.htm              | 144 +++++++++++++++++++++
 1 file changed, 144 insertions(+)

diff --git a/org.tizen.sampledescriptions/html/mobile_n/appcommon_sd_mn.htm b/org.tizen.sampledescriptions/html/mobile_n/appcommon_sd_mn.htm
index ae5d4ac..ed635a4 100644
--- a/org.tizen.sampledescriptions/html/mobile_n/appcommon_sd_mn.htm
+++ b/org.tizen.sampledescriptions/html/mobile_n/appcommon_sd_mn.htm
@@ -171,7 +171,151 @@ typedef enum {
 } path_item_type;
 </pre>
 
+<h3 id="app-init">Application initialization</h3>
 
+  <p>
+  The entire application life-cycle is implemented in the main source file, using a common Tizen application structure:
+  </p>
+
+<pre class="prettyprint">
+int main(int argc, char *argv[])
+{
+&nbsp;&nbsp;&nbsp;appdata_s ad = {{0,},};
+&nbsp;&nbsp;&nbsp;int ret = 0;
+&nbsp;&nbsp;&nbsp;ui_app_lifecycle_callback_s event_callback;
+
+&nbsp;&nbsp;&nbsp;event_callback.create = __create_app;
+&nbsp;&nbsp;&nbsp;event_callback.terminate = __terminate_app;
+&nbsp;&nbsp;&nbsp;event_callback.pause = __pause_app;
+&nbsp;&nbsp;&nbsp;event_callback.resume = __resume_app;
+&nbsp;&nbsp;&nbsp;event_callback.app_control = __control_app;
+
+&nbsp;&nbsp;&nbsp;ret = ui_app_main(argc, argv, &event_callback, &ad);
+&nbsp;&nbsp;&nbsp;if (ret != APP_ERROR_NONE)
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;controller_log(DLOG_ERROR, "Function ui_app_main() failed with error = %d", ret);
+
+&nbsp;&nbsp;&nbsp;return ret;
+}
+</pre>
+
+  <p>
+  The application's initilization procedure is executed in <span style="font-family: Courier New,Courier,monospace">__create_app()</span> callback function, which is invoked on application's startup.
+  </p>
+
+<pre class="prettyprint">
+static bool __create_app(void *data)
+{
+&nbsp;&nbsp;&nbsp;appdata_s *ad = (appdata_s *)data;
+
+&nbsp;&nbsp;&nbsp;return controller_init(&ad->view, &ad->model);
+}
+</pre>
+
+  <p>
+  Finally, the <span style="font-family: Courier New,Courier,monospace">controller_init()</span> function is invoked, which controls the entire initialization process
+  (see the code snippet below for details).
+  </p>
+
+<pre class="prettyprint">
+bool controller_init(viewdata_s *vd, modeldata_s *md)
+{
+&nbsp;&nbsp;&nbsp;if (!model_init(md))
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return false;
+
+&nbsp;&nbsp;&nbsp;if (!__add_event_handlers())
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return false;
+
+&nbsp;&nbsp;&nbsp;if (!view_create_base_gui(vd, __paths_popup_opened))
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return false;
+
+&nbsp;&nbsp;&nbsp;__init_view_app();
+
+&nbsp;&nbsp;&nbsp;return true;
+}
+</pre>
+
+  <p>
+  The following functions, listed within the code snippet above, are responsible for:
+  <ul>
+    <li>
+	<span style="font-family: Courier New,Courier,monospace">model_init()</span> - model-related data pointer storage for future use within the "model" module;
+<pre class="prettyprint">
+bool model_init(modeldata_s *md)
+{
+&nbsp;&nbsp;&nbsp;if (!md) {
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;controller_log(DLOG_ERROR, "Invalid argument");
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return false;
+&nbsp;&nbsp;&nbsp;}
+
+&nbsp;&nbsp;&nbsp;__modeldata = md;
+
+&nbsp;&nbsp;&nbsp;return (__modeldata != NULL);
+}
+</pre>
+	</li>
+	<li>
+	<span style="font-family: Courier New,Courier,monospace">__add_event_handlers()</span> - events handlers assignments;
+<pre class="prettyprint">
+static bool __add_event_handlers(void)
+{
+&nbsp;&nbsp;&nbsp;return (model_add_event_handler(APP_EVENT_LOW_BATTERY, __app_event_low_battery_cb) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_add_event_handler(APP_EVENT_LOW_MEMORY, __app_event_low_memory_cb) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_add_event_handler(APP_EVENT_DEVICE_ORIENTATION_CHANGED, __app_event_device_orientation_changed_cb) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_add_event_handler(APP_EVENT_LANGUAGE_CHANGED, __app_event_language_changed_cb) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_add_event_handler(APP_EVENT_REGION_FORMAT_CHANGED, __app_event_region_format_changed_cb) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_add_event_handler(APP_EVENT_SUSPENDED_STATE_CHANGED, __app_event_suspended_state_changed_cb));
+}
+</pre>
+	See the <a href="#model">Model</a> section for <span style="font-family: Courier New,Courier,monospace">model_add_event_handler()</span> function reference.
+	</li>
+	<li>
+	<span style="font-family: Courier New,Courier,monospace">view_create_base_gui()</span> - the entire UI is created. The source code is not listed within this documentation, as it is not a subject
+	of this document.
+	</li>
+	<li>
+	<span style="font-family: Courier New,Courier,monospace">__init_view_app()</span> - the set of application's common information is obtained via <a href="#model">Model</a> module functions, which
+	is then displayed in the UI.
+<pre class="prettyprint">
+static void __init_view_app(void)
+{
+&nbsp;&nbsp;&nbsp;char *id = NULL;
+&nbsp;&nbsp;&nbsp;char *name = NULL;
+&nbsp;&nbsp;&nbsp;char *version = NULL;
+
+&nbsp;&nbsp;&nbsp;if (model_app_get_id(&id) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_name(&name) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_version(&version))
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;view_update_application_tab(id, name, version);
+
+&nbsp;&nbsp;&nbsp;char *paths[PATHS_LIST_ITEMS_COUNT] = { NULL };
+
+&nbsp;&nbsp;&nbsp;if (model_app_get_data_path(&paths[PIT_DATA]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_cache_path(&paths[PIT_CACHE]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_resource_path(&paths[PIT_RESOURCE]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_shared_data_path(&paths[PIT_SHARED_DATA]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_shared_resource_path(&paths[PIT_SHARED_RESOURCE]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_shared_trusted_path(&paths[PIT_SHARED_TRUSTED]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_external_data_path(&paths[PIT_EXTERNAL_DATA]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_external_cache_path(&paths[PIT_EXTERNAL_CACHE]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_external_shared_data_path(&paths[PIT_EXTERNAL_SHARED_DATA]) &&
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_app_get_tep_resource_path(&paths[PIT_TEP_RESOURCE])) {
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int i;
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;view_update_paths_tab(paths);
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for (i = 0; i < PATHS_LIST_ITEMS_COUNT; i++)
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;free(paths[i]);
+&nbsp;&nbsp;&nbsp;}
+}
+</pre>
+	</li>
+  </ul>
+  If any of the above functions (except <span style="font-family: Courier New,Courier,monospace">__init_view_app()</span>) fails, then application is terminated and the
+  <span style="font-family: Courier New,Courier,monospace">__terminate_app()</span> callback function is called. For details, see the <a href="#app-finit">Application termination<a> section.
+  </p>
+
+<h3 id="app-finit">Application termination</h3>
+
+<h3 id="model">Model</h3>
 
 <script type="text/javascript" src="../scripts/jquery.zclip.min.js"></script>
 <script type="text/javascript" src="../scripts/showhide.js"></script>
-- 
2.7.4