feat: CPP App-Passthrough (#196)

* fix: Added app-passthrough functionality for cpp sdk * cPP: Updates based on provider schema changes * CPP: Updates based on provider schema changes * fix: Make small adjustment to interface template and engine logic * fix: Revert changes that were being tested * feat: Pass config flag to types.mjs to modify schema title * fix: Update cpp templates for discoverySDK WIP * fix: Added support for players and fixed few provider issues * fix: Commented file permission code for debug * fix: Update templates to be more verbose * fix: Added version opt in include.sh * fix: Added set -e in build.sh * fix: Make focuable interface separate * fix: Comment out side-effect ridden code * fix: Added IModule.h in firebolt.cpp --------- Co-authored-by: HaseenaSainul <[email protected]> Co-authored-by: Shah, Kevin <[email protected]> Co-authored-by: kschrief <[email protected]>
rdkcentral · Jul 29, 2024 · eeabccb · eeabccb
1 parent c5c049e
commit eeabccb
Show file tree

Hide file tree

Showing 23 changed files with 173 additions and 77 deletions.
diff --git a/languages/cpp/language.config.json b/languages/cpp/language.config.json
@@ -7,6 +7,7 @@
     "createPolymorphicMethods": true,
     "excludeDeclarations": true,
     "extractProviderSchema": true,
+    "enableUnionTypes": false,
     "aggregateFiles": [
         "/include/firebolt.h",
         "/src/firebolt.cpp"

diff --git a/languages/cpp/src/shared/src/Logger/Logger.cpp b/languages/cpp/src/shared/src/Logger/Logger.cpp
@@ -37,6 +37,8 @@ ENUM_CONVERSION_BEGIN(FireboltSDK::Logger::Category)
     { FireboltSDK::Logger::Category::Core, _TXT("FireboltSDK::Core") },
     { FireboltSDK::Logger::Category::Manage, _TXT("FireboltSDK::Manage") },
     { FireboltSDK::Logger::Category::Discovery, _TXT("FireboltSDK::Discovery") },
+    { FireboltSDK::Logger::Category::PlayerProvider, _TXT("FireboltSDK::PlayerProvider") },
+    { FireboltSDK::Logger::Category::PlayerProvider, _TXT("FireboltSDK::PlayerManager") },
 
 ENUM_CONVERSION_END(FireboltSDK::Logger::Category)
 

diff --git a/languages/cpp/src/shared/src/Logger/Logger.h b/languages/cpp/src/shared/src/Logger/Logger.h
@@ -39,7 +39,9 @@ namespace FireboltSDK {
             OpenRPC,
             Core,
             Manage,
-            Discovery
+            Discovery,
+            PlayerProvider,
+            PlayerManager,
         };
 
     public:

diff --git a/languages/cpp/templates/callback-initialization/tuple.cpp b/languages/cpp/templates/callback-initialization/tuple.cpp
@@ -0,0 +1 @@
+${if.namespace.notsame}${parent.Title}::${end.if.namespace.notsame}${title} ${property};
diff --git a/languages/cpp/templates/callback-result-instantiation/sub-property/array.cpp b/languages/cpp/templates/callback-result-instantiation/sub-property/array.cpp
@@ -6,5 +6,4 @@
                 }
             }${end.if.optional}${if.non.optional}auto index((*proxyResponse)${Property.dependency}.${Property}.Elements());
             while (index.Next() == true) {
-${if.object}${items.with.indent}${end.if.object}${if.non.object}                ${base.title}${property.dependency}${if.impl.optional}.value()${end.if.impl.optional}.${property}.value().push_back(index.Current().Value());${end.if.non.object}
-            }${end.if.non.optional}
+${if.object}${items.with.indent}${end.if.object}${if.non.object} ${base.title}${property.dependency}${if.impl.optional}.value()${end.if.impl.optional}.${property}.push_back(index.Current().Value());${end.if.non.object}            }${end.if.non.optional}
diff --git a/languages/cpp/templates/codeblocks/interface-focusable.cpp b/languages/cpp/templates/codeblocks/interface-focusable.cpp
@@ -0,0 +1,47 @@
+    static void ProviderInvokeSession(std::string& methodName, JsonObject& jsonParameters, Firebolt::Error *err = nullptr)
+    {
+        Firebolt::Error status = Firebolt::Error::NotConnected;
+        FireboltSDK::Transport<WPEFramework::Core::JSON::IElement>* transport = FireboltSDK::Accessor::Instance().GetTransport();
+        if (transport != nullptr) {
+
+            JsonObject jsonResult;
+            status = transport->Invoke(methodName, jsonParameters, jsonResult);
+            if (status == Firebolt::Error::None) {
+                FIREBOLT_LOG_INFO(FireboltSDK::Logger::Category::OpenRPC, FireboltSDK::Logger::Module<FireboltSDK::Accessor>(), "%s is successfully invoked", methodName.c_str());
+            }
+
+        } else {
+            FIREBOLT_LOG_ERROR(FireboltSDK::Logger::Category::OpenRPC, FireboltSDK::Logger::Module<FireboltSDK::Accessor>(), "Error in getting Transport err = %d", status);
+        }
+        if (err != nullptr) {
+            *err = status;
+        }
+    }
+    static void ProviderFocusSession(std::string methodName, std::string& correlationId, Firebolt::Error *err = nullptr)
+    {
+        JsonObject jsonParameters;
+        WPEFramework::Core::JSON::Variant CorrelationId(correlationId);
+        jsonParameters.Set(_T("correlationId"), CorrelationId);
+
+        ProviderInvokeSession(methodName, jsonParameters, err);
+    }
+    static void ProviderResultSession(std::string methodName, std::string& correlationId, ${provider.xresponse.name} result, Firebolt::Error *err = nullptr)
+    {
+        JsonObject jsonParameters;
+        WPEFramework::Core::JSON::Variant CorrelationId(correlationId);
+        jsonParameters.Set(_T("correlationId"), CorrelationId);
+
+${provider.xresponse.serialization}
+        ProviderInvokeSession(methodName, jsonParameters, err);
+    }
+    static void ProviderErrorSession(std::string methodName, std::string& correlationId, ${provider.xerror.name} result, Firebolt::Error *err = nullptr)
+    {
+        JsonObject jsonParameters;
+        WPEFramework::Core::JSON::Variant CorrelationId(correlationId);
+        jsonParameters.Set(_T("correlationId"), CorrelationId);
+
+${provider.xerror.serialization}
+        ProviderInvokeSession(methodName, jsonParameters, err);
+    }
+
+${methods}
diff --git a/languages/cpp/templates/codeblocks/interface-focusable.h b/languages/cpp/templates/codeblocks/interface-focusable.h
@@ -0,0 +1,12 @@
+struct I${info.Title}Session : virtual public IFocussableProviderSession {
+    virtual ~I${info.Title}Session() override = default;
+
+    virtual void error( ${provider.xerror.name} error, Firebolt::Error *err = nullptr ) = 0;
+    virtual void result( ${provider.xresponse.name} result, Firebolt::Error *err = nullptr ) = 0;
+};
+
+struct I${info.Title}Provider {
+    virtual ~I${info.Title}Provider() = default;
+
+${methods}
+};
diff --git a/languages/cpp/templates/codeblocks/interface.cpp b/languages/cpp/templates/codeblocks/interface.cpp
@@ -17,31 +17,5 @@
             *err = status;
         }
     }
-    static void ProviderFocusSession(std::string methodName, std::string& correlationId, Firebolt::Error *err = nullptr)
-    {
-        JsonObject jsonParameters;
-        WPEFramework::Core::JSON::Variant CorrelationId(correlationId);
-        jsonParameters.Set(_T("correlationId"), CorrelationId);
-
-        ProviderInvokeSession(methodName, jsonParameters, err);
-    }
-    static void ProviderResultSession(std::string methodName, std::string& correlationId, ${provider.xresponse.name} result, Firebolt::Error *err = nullptr)
-    {
-        JsonObject jsonParameters;
-        WPEFramework::Core::JSON::Variant CorrelationId(correlationId);
-        jsonParameters.Set(_T("correlationId"), CorrelationId);
-
-${provider.xresponse.serialization}
-        ProviderInvokeSession(methodName, jsonParameters, err);
-    }
-    static void ProviderErrorSession(std::string methodName, std::string& correlationId, ${provider.xerror.name} result, Firebolt::Error *err = nullptr)
-    {
-        JsonObject jsonParameters;
-        WPEFramework::Core::JSON::Variant CorrelationId(correlationId);
-        jsonParameters.Set(_T("correlationId"), CorrelationId);
-
-${provider.xerror.serialization}
-        ProviderInvokeSession(methodName, jsonParameters, err);
-    }
 
 ${methods}
diff --git a/languages/cpp/templates/codeblocks/interface.h b/languages/cpp/templates/codeblocks/interface.h
@@ -1,12 +1,5 @@
-struct I${info.Title}Session : virtual public IFocussableProviderSession {
-    virtual ~I${info.Title}Session() override = default;
-
-    virtual void error( ${provider.xerror.name} error, Firebolt::Error *err = nullptr ) = 0;
-    virtual void result( ${provider.xresponse.name} result, Firebolt::Error *err = nullptr ) = 0;
-};
-
 struct I${info.Title}Provider {
     virtual ~I${info.Title}Provider() = default;
 
 ${methods}
-};
+};
diff --git a/languages/cpp/templates/interfaces/default.cpp b/languages/cpp/templates/interfaces/default.cpp
@@ -10,8 +10,17 @@
     };
     static void ${info.Title}${method.Name}SessionInnerCallback( void* provider, const void* userData, void* jsonResponse )
     {
-        //TODO: code to convert jsonResponse to ${method.name} session
-        I${info.Title}Provider& ${info.title.lowercase}Provider = *(reinterpret_cast<I${info.Title}Provider*>(provider));
-        ${info.title.lowercase}Provider.${method.name}( parameters, session );
-    }
+${event.callback.serialization}
+        ASSERT(proxyResponse.IsValid() == true);
+
+        if (proxyResponse.IsValid() == true) {
+${event.callback.initialization}
 
+${event.callback.instantiation}
+            proxyResponse.Release();
+
+            std::unique_ptr<IProviderSession> ${info.title.lowercase}${method.Name}Session = std::make_unique<${info.Title}${method.Name}Session>();
+            I${info.Title}Provider& ${info.title.lowercase}Provider = *(reinterpret_cast<I${info.Title}Provider*>(provider));
+            ${info.title.lowercase}Provider.${method.name}(${method.result.name}.parameters, std::move(${info.title.lowercase}${method.Name}Session));
+        }
+    }
diff --git a/languages/cpp/templates/interfaces/default.h b/languages/cpp/templates/interfaces/default.h
@@ -1 +1 @@
-    virtual void ${method.name}( ${method.signature.params}, IProviderSession& session ) = 0;
+    virtual void ${method.name}( ${method.signature.params}, std::unique_ptr<IProviderSession> session ) = 0;
diff --git a/languages/cpp/templates/methods/default.cpp b/languages/cpp/templates/methods/default.cpp
@@ -1,25 +1,25 @@
     /* ${method.name} - ${method.description} */
     ${method.signature.result} ${info.Title}Impl::${method.name}( ${method.signature.params}${if.params}, ${end.if.params}Firebolt::Error *err ) ${if.result.nonvoid}${if.params.empty} const${end.if.params.empty}${end.if.result.nonvoid}
     {
-        Firebolt::Error status = Firebolt::Error::NotConnected;
+        Firebolt::Error statusError = Firebolt::Error::NotConnected;
 ${if.result.nonvoid}${method.result.initialization}${end.if.result.nonvoid}
         FireboltSDK::Transport<WPEFramework::Core::JSON::IElement>* transport = FireboltSDK::Accessor::Instance().GetTransport();
         if (transport != nullptr) {
 
             JsonObject jsonParameters;
     ${method.params.serialization.with.indent}
             ${method.result.json.type} jsonResult;
-            status = transport->Invoke("${info.title.lowercase}.${method.name}", jsonParameters, jsonResult);
-            if (status == Firebolt::Error::None) {
+            statusError = transport->Invoke("${info.title.lowercase}.${method.name}", jsonParameters, jsonResult);
+            if (statusError == Firebolt::Error::None) {
                 FIREBOLT_LOG_INFO(FireboltSDK::Logger::Category::OpenRPC, FireboltSDK::Logger::Module<FireboltSDK::Accessor>(), "${info.Title}.${method.name} is successfully invoked");
     ${if.result.nonvoid}${method.result.instantiation.with.indent}${end.if.result.nonvoid}
             }
 
         } else {
-            FIREBOLT_LOG_ERROR(FireboltSDK::Logger::Category::OpenRPC, FireboltSDK::Logger::Module<FireboltSDK::Accessor>(), "Error in getting Transport err = %d", status);
+            FIREBOLT_LOG_ERROR(FireboltSDK::Logger::Category::OpenRPC, FireboltSDK::Logger::Module<FireboltSDK::Accessor>(), "Error in getting Transport err = %d", statusError);
         }
         if (err != nullptr) {
-            *err = status;
+            *err = statusError;
         }
 
         return${if.result.nonvoid} ${method.result.name}${end.if.result.nonvoid};

diff --git a/languages/cpp/templates/parameter-serialization/enum.cpp b/languages/cpp/templates/parameter-serialization/enum.cpp
@@ -1,7 +1,7 @@
         ${if.optional}if (${property}.has_value()) {
-            ${if.namespace.notsame}Firebolt::${info.Title}::${end.if.namespace.notsame}JsonData_${title} jsonValue = ${property}.value();
-            WPEFramework::Core::JSON::Variant ${property}Variant(jsonValue.Data());
+            ${if.namespace.notsame}Firebolt::${info.Title}::${end.if.namespace.notsame}JsonData_${title} json${Property} = ${property}.value();
+            WPEFramework::Core::JSON::Variant ${property}Variant(json${Property}.Data());
             jsonParameters.Set(_T("${property}"), ${property}Variant);
-        }${end.if.optional}${if.non.optional}${if.namespace.notsame}Firebolt::${info.Title}::${end.if.namespace.notsame}JsonData_${title} jsonValue = ${property};
-        WPEFramework::Core::JSON::Variant ${property}Variant(jsonValue.Data());
+        }${end.if.optional}${if.non.optional}${if.namespace.notsame}Firebolt::${info.Title}::${end.if.namespace.notsame}JsonData_${title} json${Property} = ${property};
+        WPEFramework::Core::JSON::Variant ${property}Variant(json${Property}.Data());
         jsonParameters.Set(_T("${property}"), ${property}Variant);${end.if.non.optional}
diff --git a/languages/cpp/templates/result-instantiation/sub-property/array.cpp b/languages/cpp/templates/result-instantiation/sub-property/array.cpp
@@ -1,10 +1,10 @@
-            ${if.optional}if (jsonResult.${Property}.IsSet()) {
-                ${base.title}Result${level}.${property} = std::make_optional<${type}>();
-                auto index(jsonResult.${Property}.Elements());
-                while (index.Next() == true) {
-    ${if.object}${items.with.indent}${end.if.object}${if.non.object}                ${base.title}Result${level}.${property}.value().push_back(index.Current().Value());${end.if.non.object}
+            ${if.optional}if (jsonResult${Property.dependency}.${Property}.IsSet()) {
+                ${base.title}Result${level}${property.dependency}${if.impl.optional}.value()${end.if.impl.optional}.${property} = std::make_optional<${type}>();
+                auto ${property}Index(jsonResult${Property.dependency}.${Property}.Elements());
+                while (${property}Index.Next() == true) {
+    ${if.object}${items.with.indent}${end.if.object}${if.non.object}                ${base.title}Result${level}.${property}.value().push_back(${property}Index.Current().Value());${end.if.non.object}
                 }
-            }${end.if.optional}${if.non.optional}auto index(jsonResult.${Property}.Elements());
-            while (index.Next() == true) {
-    ${if.object}${items.with.indent}${end.if.object}${if.non.object}                    ${base.title}Result${level}.${property}.push_back(index.Current().Value());${end.if.non.object}
+            }${end.if.optional}${if.non.optional}auto ${property}Index(jsonResult.${Property}.Elements());
+            while (${property}Index.Next() == true) {
+    ${if.object}${items.with.indent}${end.if.object}${if.non.object}                    ${base.title}Result${level}.${property}.push_back(${property}Index.Current().Value());${end.if.non.object}
            }${end.if.non.optional}
diff --git a/languages/cpp/templates/result-instantiation/sub-property/object-array.cpp b/languages/cpp/templates/result-instantiation/sub-property/object-array.cpp
@@ -1,6 +1,6 @@
                 ${type} ${property}Result${level};
-            ${if.namespace.notsame}Firebolt::${info.Title}::${end.if.namespace.notsame}JsonData_${title} jsonResult = index.Current();
+            ${if.namespace.notsame}Firebolt::${info.Title}::${end.if.namespace.notsame}JsonData_${title} jsonResult = ${property}Index.Current();
             {
 ${properties}
             }
-            ${property}Result.${property}${if.impl.array.optional}.value()${end.if.impl.array.optional}.push_back(${property}Result${level});
+            ${base.title}Result${property.dependency}${if.impl.optional}.value()${end.if.impl.optional}.${property}.push_back(${property}Result${level});
diff --git a/languages/cpp/templates/sdk/scripts/build.sh b/languages/cpp/templates/sdk/scripts/build.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e
 usage()
 {
    echo "options:"

diff --git a/languages/cpp/templates/sdk/scripts/install.sh b/languages/cpp/templates/sdk/scripts/install.sh
@@ -5,6 +5,7 @@ usage()
    echo "    -i install path"
    echo "    -s sdk path"
    echo "    -m module name. i.e, core/manage"
+   echo "    -v sdk version. i.e, 1.3.0"
    echo
    echo "usage: "
    echo "    ./install.sh -i path -s sdk path -m core"
@@ -13,12 +14,15 @@ usage()
 SdkPath=".."
 InstallPath=".."
 ModuleName="core"
-while getopts i:s:m:h flag
+Version=1.3.0-next.1
+
+while getopts i:s:m:v:h flag
 do
     case "${flag}" in
         i) InstallPath="${OPTARG}";;
         s) SdkPath="${OPTARG}";;
         m) ModuleName="${OPTARG}";;
+        v) Version="${OPTARG}";;
         h) usage && exit 1;;
     esac
 done
@@ -40,8 +44,7 @@ GetVersion()
   Version=${array[2]}
 }
 
-Version=0.0
-GetVersion
+#GetVersion
 ReleaseName=firebolt-${ModuleName}-native-sdk-${Version}
 ReleasePath=${InstallPath}/${ReleaseName}
 

diff --git a/languages/cpp/templates/sdk/src/firebolt.cpp b/languages/cpp/templates/sdk/src/firebolt.cpp
@@ -18,6 +18,7 @@
 
 #include <firebolt.h>
 #include "FireboltSDK.h"
+#include "IModule.h"
 ${module.includes.private}
 
 namespace Firebolt {

diff --git a/src/macrofier/engine.mjs b/src/macrofier/engine.mjs
@@ -1775,16 +1775,24 @@ function getProviderXValues(method) {
   return xValues
 }
 
-function insertProviderXValues(template, moduleJson, xValues) {
+function insertProviderXValues(template, module, xValues) {
   if (xValues['x-response']) {
-    const xResponseInst = types.getSchemaShape(xValues['x-response'], moduleJson, { templateDir: 'parameter-serialization', property: 'result', required: true, destination: state.destination, section: state.section, primitive: true, skipTitleOnce: true })
+    let schema = localizeDependencies(xValues['x-response'], module)
+    const moduleTitle = types.getXSchemaGroup(schema, module)
+    const xResponseInst = types.getSchemaShape(schema, module, { templateDir: 'parameter-serialization', property: 'result', required: true, destination: state.destination, section: state.section, primitive: true, skipTitleOnce: true })
+    const type = types.getSchemaType(schema, module, { moduleTitle: moduleTitle, result: true, namespace: true})
     template = template.replace(/\$\{provider\.xresponse\.serialization\}/gms, xResponseInst)
-      .replace(/\$\{provider\.xresponse\.name\}/gms, xValues['x-response'].title)
+      .replace(/\$\{provider\.xresponse\.name\}/gms, type)
+      .replace(/\$\{parent\.Title\}/g, capitalize(moduleTitle))
   }
   if (xValues['x-error']) {
-    const xErrorInst = types.getSchemaShape(xValues['x-error'], moduleJson, { templateDir: 'parameter-serialization', property: 'result', required: true, destination: state.destination, section: state.section, primitive: true, skipTitleOnce: true })
+    let schema = localizeDependencies(xValues['x-error'], module)
+    const moduleTitle = types.getXSchemaGroup(schema, module)
+    const xErrorInst = types.getSchemaShape(schema, module, { templateDir: 'parameter-serialization', property: 'result', required: true, destination: state.destination, section: state.section, primitive: true, skipTitleOnce: true })
+    const type = types.getSchemaType(schema, module, { moduleTitle: moduleTitle, result: true, namespace: true})
     template = template.replace(/\$\{provider\.xerror\.serialization\}/gms, xErrorInst)
-      .replace(/\$\{provider\.xerror\.name\}/gms, xValues['x-error'].title)
+      .replace(/\$\{provider\.xerror\.name\}/gms, type)
+      .replace(/\$\{parent\.Title\}/g, capitalize(moduleTitle))
   }
   return template
 }
@@ -1805,9 +1813,24 @@ function insertProviderInterfaceMacros(template, capability, moduleJson = {}, te
   let name = getProviderInterfaceName(iface, capability, moduleJson)
   let xValues
   const suffix = state.destination ? state.destination.split('.').pop() : ''
-  let interfaceShape = getTemplate(suffix ? `/codeblocks/interface.${suffix}` : '/codeblocks/interface', templates)
-  if (!interfaceShape) {
-    interfaceShape = getTemplate('/codeblocks/interface', templates)
+
+  // Determine if any method has the 'x-allow-focus' tag set to true
+  const hasFocusableMethods = iface.some(method => 
+    method.tags.some(tag => tag['x-allow-focus'] === true)
+  )
+
+  // Determine the appropriate template based on hasFocusableMethods and suffix
+  let interfaceShape;
+  if (hasFocusableMethods) {
+    interfaceShape = getTemplate(suffix ? `/codeblocks/interface-focusable.${suffix}` : '/codeblocks/interface-focusable', templates);
+    if (!interfaceShape) {
+      interfaceShape = getTemplate('/codeblocks/interface-focusable', templates);
+    }
+  } else {
+    interfaceShape = getTemplate(suffix ? `/codeblocks/interface.${suffix}` : '/codeblocks/interface', templates);
+    if (!interfaceShape) {
+      interfaceShape = getTemplate('/codeblocks/interface', templates);
+    }
   }
 
   interfaceShape = interfaceShape.replace(/\$\{name\}/g, name)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		${if.namespace.notsame}${parent.Title}::${end.if.namespace.notsame}${title} ${property};
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		virtual void ${method.name}( ${method.signature.params}, IProviderSession& session ) = 0;
		virtual void ${method.name}( ${method.signature.params}, std::unique_ptr<IProviderSession> session ) = 0;