[API] Logging warnings for deprecated API elements

[Details] Added warnings which are logged when deprecated
elements are used. Both in C++ and JavaScript.

[Verification] Code compiles without errors and warnings shows
up for deprecated API elements.

Change-Id: I50bb501a5b29bb59d01ac5c0847ea6dac7203a98
Signed-off-by: Mateusz Bruno-Kaminski <m.bruno2@samsung.com>

diff --git a/src/application/application_api.js b/src/application/application_api.js
index 7b42f15c0c86b8eed0f286e1ee475db0b4042025..77805ef87c68c4d309e7a170d523cee989cf8a39 100755 (executable)
--- a/src/application/application_api.js
+++ b/src/application/application_api.js
@@ -564,6 +564,9 @@ var APPLICATION_EVENT_LISTENER = 'ApplicationEventListener';
 var applicationEventListener = new ListenerManager(native, APPLICATION_EVENT_LISTENER);
 
 ApplicationManager.prototype.addAppInfoEventListener = function() {
+  console.warn('DEPRECATION WARNING: addAppInfoEventListener() is deprecated and will be removed from next release. '
+      + 'Use tizen.package.setPackageInfoEventListener() instead.');
+
   var args = AV.validateMethod(arguments, [
       {
         name : 'eventCallback',
@@ -576,6 +579,9 @@ ApplicationManager.prototype.addAppInfoEventListener = function() {
 };
 
 ApplicationManager.prototype.removeAppInfoEventListener = function() {
+  console.warn('DEPRECATION WARNING: removeAppInfoEventListener() is deprecated and will be removed from next release. '
+      + 'Use tizen.package.unsetPackageInfoEventListener() instead.');
+
   var args = AV.validateMethod(arguments, [
       {
         name : 'watchId',

diff --git a/src/application/application_instance.cc b/src/application/application_instance.cc
index 67ff539d538debac1ecd87ff9f61ae14db343669..cb8d850ae56785343748ccdf27fcfddaddca77db 100755 (executable)
--- a/src/application/application_instance.cc
+++ b/src/application/application_instance.cc
@@ -159,12 +159,16 @@ void ApplicationInstance::GetAppMetaData(const picojson::value& args, picojson::
 
 void ApplicationInstance::AddAppInfoEventListener(const picojson::value& args, picojson::object& out) {
   LoggerD("Entered");
+  LoggerW("DEPRECATION WARNING: addAppInfoEventListener() is deprecated and will be removed from next release. "
+      "Use tizen.package.setPackageInfoEventListener() instead.");
 
   manager_.StartAppInfoEventListener(&out);
  }
 
 void ApplicationInstance::RemoveAppInfoEventListener(const picojson::value& args, picojson::object& out) {
   LoggerD("Entered");
+  LoggerW("DEPRECATION WARNING: removeAppInfoEventListener() is deprecated and will be removed from next release. "
+        "Use tizen.package.unsetPackageInfoEventListener() instead.");
 
   manager_.StopAppInfoEventListener();
   ReportSuccess(out);

diff --git a/src/bluetooth/bluetooth_adapter.cc b/src/bluetooth/bluetooth_adapter.cc
index e4283d669852ad3b924c264e9144bfe5384596e4..396211dc269fafe66be5eaba2ca6b4867967ac1c 100755 (executable)
--- a/src/bluetooth/bluetooth_adapter.cc
+++ b/src/bluetooth/bluetooth_adapter.cc
@@ -516,6 +516,8 @@ void BluetoothAdapter::SetName(const picojson::value& data, picojson::object& ou
 
 void BluetoothAdapter::SetPowered(const picojson::value& data, picojson::object& out) {
   LoggerD("Entered");
+  LoggerW("DEPRECATION WARNING: setPowered() is deprecated and will be removed from next release. "
+        "Let the user turn on/off Bluetooth through the Settings application instead.");
 
   CHECK_BACKWARD_COMPABILITY_PRIVILEGE_ACCESS(Privilege::kBluetooth,
                                               Privilege::kBluetoothAdmin, &out);

diff --git a/src/bluetooth/bluetooth_api.js b/src/bluetooth/bluetooth_api.js
index 06c5fe92d4d31c0f5005a4fa391607ffc9d91da8..c1c1864c1c9c9f4c18b93517dbeaf7d1015e56ee 100755 (executable)
--- a/src/bluetooth/bluetooth_api.js
+++ b/src/bluetooth/bluetooth_api.js
@@ -2030,6 +2030,9 @@ BluetoothAdapter.prototype.setName = function() {
 
 BluetoothAdapter.prototype.setPowered = function() {
     console.log('Entered BluetoothAdapter.setPowered()');
+    console.warn('DEPRECATION WARNING: setPowered() is deprecated and will be removed from next release. '
+        + 'Let the user turn on/off Bluetooth through the Settings application instead.');
+
     var args = AV.validateMethod(arguments, [
         {
             name : 'powered',

diff --git a/src/nfc/nfc_api.js b/src/nfc/nfc_api.js
index 641a4ee6fd21adadda7a0b3b274a5ae3ed58cb9a..3954049ff1d21c1833ed762c7430f10af9a29045 100644 (file)
--- a/src/nfc/nfc_api.js
+++ b/src/nfc/nfc_api.js
@@ -272,6 +272,9 @@ function NFCAdapter() {
 }
 
 NFCAdapter.prototype.setPowered = function() {
+  console.warn('DEPRECATION WARNING: setPowered() is deprecated and will be removed from next release. Let the user turn NFC on/off '
+      + 'through the Settings application instead.');
+
   var args = validator_.validateArgs(arguments, [
     {
       name: 'powered',

diff --git a/src/nfc/nfc_instance.cc b/src/nfc/nfc_instance.cc
index 781f90e80f1317d1f2b0c06fee4b625450b523a5..4c0b50e7ea7bb97adfb689e5594404ccad23b832 100644 (file)
--- a/src/nfc/nfc_instance.cc
+++ b/src/nfc/nfc_instance.cc
@@ -205,6 +205,9 @@ void NFCInstance::SetExclusiveMode(
 void NFCInstance::SetPowered(
     const picojson::value& args, picojson::object& out) {
   LoggerD("Entered");
+  LoggerW("DEPRECATION WARNING: setPowered() is deprecated and will be removed from next release. Let the user turn NFC on/off "
+      "through the Settings application instead.");
+
   CHECK_PRIVILEGE_ACCESS(kPrivilegeNfcAdmin, &out);
 
   PlatformResult result = NFCAdapter::GetInstance()->SetPowered(args);

diff --git a/src/power/power_api.js b/src/power/power_api.js
index 96c75f0c2e0d0f3dd866eeb773dabf67b2cf3304..5be10265047b0374204dc4e54be250199ebe38e2 100755 (executable)
--- a/src/power/power_api.js
+++ b/src/power/power_api.js
@@ -120,11 +120,15 @@ function PowerManager() {
  *     is desired to be.
  */
 PowerManager.prototype.request = function(resource, state) {
-   var args = validator_.validateArgs(arguments, [
+    var args = validator_.validateArgs(arguments, [
         {'name' : 'resource', 'type': types_.ENUM, 'values' : ['SCREEN', 'CPU']},
         {'name' : 'state', 'type': types_.ENUM, 'values' : ['SCREEN_OFF', 'SCREEN_DIM', 'SCREEN_NORMAL', 'SCREEN_BRIGHT', 'CPU_AWAKE']}
     ]);
 
+    if (args['state'] && args.state === PowerScreenState['SCREEN_BRIGHT']) {
+        console.warn('DEPRECATION WARNING: SCREEN_BRIGHT is deprecated and will be removed from next release.');
+    }
+
     var nativeParam = {
     };
 
@@ -273,6 +277,8 @@ PowerManager.prototype.restoreScreenBrightness = function() {
  * Turns on the screen.
  */
 PowerManager.prototype.turnScreenOn = function() {
+    console.warn('DEPRECATION WARNING: turnScreenOn() is deprecated and will be removed from next release. Use request() instead.');
+
     var nativeParam = {
     };
 
@@ -288,6 +294,8 @@ PowerManager.prototype.turnScreenOn = function() {
  * Turns off the screen.
  */
 PowerManager.prototype.turnScreenOff = function() {
+    console.warn('DEPRECATION WARNING: turnScreenOff() is deprecated and will be removed from next release. Use release() instead.');
+
     var nativeParam = {
     };
 

diff --git a/src/power/power_instance.cc b/src/power/power_instance.cc
index a4b566ded4bf6cd3cbb4b2a74629ce6ebabb6ade..8296123556ad1c55d57122000fe451743d066cb2 100755 (executable)
--- a/src/power/power_instance.cc
+++ b/src/power/power_instance.cc
@@ -173,6 +173,8 @@ void PowerInstance::PowerManagerRestorescreenbrightness(const picojson::value& a
 
 void PowerInstance::PowerManagerTurnscreenon(const picojson::value& args, picojson::object& out) {
   LoggerD("Enter");
+  LoggerW("DEPRECATION WARNING: turnScreenOn() is deprecated and will be removed from next release. Use request() instead.");
+
   CHECK_PRIVILEGE_ACCESS(kPrivilegePower, &out);
 
   PlatformResult result = PowerManager::GetInstance()->SetScreenState(true);
@@ -184,6 +186,8 @@ void PowerInstance::PowerManagerTurnscreenon(const picojson::value& args, picojs
 
 void PowerInstance::PowerManagerTurnscreenoff(const picojson::value& args, picojson::object& out) {
   LoggerD("Enter");
+  LoggerW("DEPRECATION WARNING: turnScreenOff() is deprecated and will be removed from next release. Use release() instead.");
+
   CHECK_PRIVILEGE_ACCESS(kPrivilegePower, &out);
 
   PlatformResult result = PowerManager::GetInstance()->SetScreenState(false);

diff --git a/src/power/power_manager.cc b/src/power/power_manager.cc
index 865dca4776adfc09dbab89abd871c4673baa0706..4bde5f66806163b5722acf1209033f4094a6261f 100644 (file)
--- a/src/power/power_manager.cc
+++ b/src/power/power_manager.cc
@@ -102,6 +102,12 @@ void PowerManager::OnPlatformStateChangedCB(device_callback_e type, void* value,
   switch (state) {
     case DISPLAY_STATE_NORMAL :
       current = object->bright_state_enabled_ ? POWER_STATE_SCREEN_BRIGHT : POWER_STATE_SCREEN_NORMAL;
+
+      // TODO: Remove log along with removal of deprecation power state
+      if (POWER_STATE_SCREEN_BRIGHT == current) {
+        LoggerW("DEPRECATION WARNING: SCREEN_BRIGHT is deprecated and will be removed from next release.");
+      }
+
       break;
     case DISPLAY_STATE_SCREEN_DIM :
       current = POWER_STATE_SCREEN_DIM;
@@ -187,6 +193,8 @@ PlatformResult PowerManager::Request(PowerResource resource, PowerState state) {
     }
     case POWER_STATE_SCREEN_BRIGHT:
     {
+      LoggerW("DEPRECATION WARNING: SCREEN_BRIGHT is deprecated and will be removed from next release.");
+
       int max_brightness;
       ret = device_display_get_max_brightness(0, &max_brightness);
       if (DEVICE_ERROR_NONE != ret) {
@@ -220,8 +228,11 @@ PlatformResult PowerManager::Request(PowerResource resource, PowerState state) {
       ret = device_display_get_state(&platform_state);
       if (DEVICE_ERROR_NONE != ret)
         LoggerE("device_display_get_state failed (%d)", ret);
-      if (platform_state == DISPLAY_STATE_NORMAL)
+      if (DISPLAY_STATE_NORMAL == platform_state) {
+        // TODO: Remove log along with removal of deprecation power state
+        LoggerW("DEPRECATION WARNING: SCREEN_BRIGHT is deprecated and will be removed from next release.");
         BroadcastScreenState(POWER_STATE_SCREEN_BRIGHT);
+      }
       break;
     }
     case POWER_STATE_SCREEN_OFF:
@@ -392,6 +403,8 @@ PlatformResult PowerManager::SetPlatformBrightness(int brightness) {
     should_be_read_from_cache_ = true;
     return PlatformResult(ErrorCode::NO_ERROR);
   } else if (current_state_ == POWER_STATE_SCREEN_BRIGHT) {
+    LoggerW("DEPRECATION WARNING: SCREEN_BRIGHT is deprecated and will be removed from next release.");
+
     current_brightness_ = brightness;
     LoggerD("Current state is not normal state the value is saved in cache: %d", brightness);
     should_be_read_from_cache_ = true;

diff --git a/src/push/push_api.js b/src/push/push_api.js
index afa13787e791b58c74638204d2112267537a9420..e415131b098410452a2e34dfb860985dd76b8e2f 100644 (file)
--- a/src/push/push_api.js
+++ b/src/push/push_api.js
@@ -56,7 +56,7 @@ PushManager.prototype.registerService = function() {
       values: tizen.ApplicationControl
     }
   ]);
-  console.warn('Method registerService() is deprecated, use register() instead.');
+  console.warn('DEPRECATION WARNING: registerService() is deprecated and will be removed from next release. Use register() instead.');
   this.register.apply(this, Array.prototype.slice.call(arguments, 1));
 };
 
@@ -89,7 +89,7 @@ PushManager.prototype.register = function() {
 };
 
 PushManager.prototype.unregisterService = function() {
-  console.warn('Method unregisterService() is deprecated, use unregister() instead.');
+  console.warn('DEPRECATION WARNING: unregisterService() is deprecated and will be removed from next release. Use unregister() instead.');
   this.unregister.apply(this, arguments);
 };
 

diff --git a/src/systeminfo/systeminfo_api.js b/src/systeminfo/systeminfo_api.js
index 7fae0c7aa2785b30dbe98888ced7a189abf4652b..dad6383ea47465e815057dbea33a070fe9ba55bb 100644 (file)
--- a/src/systeminfo/systeminfo_api.js
+++ b/src/systeminfo/systeminfo_api.js
@@ -729,6 +729,8 @@ var SystemInfo = function() {
 };
 
 SystemInfo.prototype.getCapabilities = function() {
+    console.warn('DEPRECATION WARNING: getCapabilities() is deprecated and will be removed from next release. Use getCapability() instead.');
+
     var result = native_.callSync('SystemInfo_getCapabilities', {});
     if (native_.isFailure(result)) {
         throw native_.getErrorObject(result);

diff --git a/src/systeminfo/systeminfo_instance.cc b/src/systeminfo/systeminfo_instance.cc
index 8f6ad504c6fd0206e6d02a1321d2593075a9bf7f..15961ecfe6c2380b430b328798f8dc7a546b8ced 100644 (file)
--- a/src/systeminfo/systeminfo_instance.cc
+++ b/src/systeminfo/systeminfo_instance.cc
@@ -81,6 +81,8 @@ SysteminfoInstance::~SysteminfoInstance() {
 
 void SysteminfoInstance::GetCapabilities(const picojson::value& args, picojson::object& out) {
   LoggerD("Enter");
+  LoggerW("DEPRECATION WARNING: getCapabilities() is deprecated and will be removed from next release. Use getCapability() instead.");
+
   manager_.GetCapabilities(args, &out);
 }
 

diff --git a/src/time/time_api.js b/src/time/time_api.js
index ea6962b67f59cb0edbaf31f6d65f68b1f9544a7b..67ae67427d91a01bc730dd6704ab5ca7f2c1d4b3 100644 (file)
--- a/src/time/time_api.js
+++ b/src/time/time_api.js
@@ -533,6 +533,8 @@ tizen.TZDate.prototype.toString = function() {
 
 tizen.TZDate.prototype.getTimezoneAbbreviation = function() {
   console.log('Entered TZDate.getTimezoneAbbreviation');
+  console.warn('DEPRECATION WARNING: getTimezoneAbbreviation() is deprecated and will be removed from next release.');
+
   var result = native_.callSync('TZDate_getTimezoneAbbreviation',
       {timezone: String(this._timezoneName),
     timestamp: String(this._utcTimestamp)});

diff --git a/src/time/time_instance.cc b/src/time/time_instance.cc
index c6e9cf2021a549accdca3e74f88f43bcb09c7149..1e63ece461f3ed19372be8b39e7714172a7713c3 100644 (file)
--- a/src/time/time_instance.cc
+++ b/src/time/time_instance.cc
@@ -256,6 +256,8 @@ void TimeInstance::TZDate_toString(const picojson::value& args, picojson::object
 void TimeInstance::TZDate_getTimezoneAbbreviation(const picojson::value& args,
                                                   picojson::object& out) {
   LoggerD("Entered");
+  LoggerW("DEPRECATION WARNING: getTimezoneAbbreviation() is deprecated and will be removed from next release.");
+
   if (!args.contains("timezone") || !args.contains("timestamp")) {
     LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
                       ("Required parameters are missing: \"timezone\", \"timestamp\""));