Revised Generator Workflow Proposal #1112 (#689) (#1120)

* Revised Generator Workflow Proposal #1112 support in RteModel Co-authored-by: Evgueni Driouk <[email protected]> Co-authored-by: Daniel Brondani <[email protected]>
Open-CMSIS-Pack · Sep 12, 2023 · 54b2e70 · 54b2e70
1 parent 684aaa8
commit 54b2e70
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 7 deletions.
diff --git a/libs/rtemodel/include/RteCallback.h b/libs/rtemodel/include/RteCallback.h
@@ -39,6 +39,7 @@ static const unsigned int RTE_MB_ICONEXCLAMATION = 0x00000030;
 static const unsigned int RTE_MB_ICONASTERISK    = 0x00000040;
 
 class RteKernel;
+class RteGenerator;
 /**
  * @brief Class to allow RTE to call application or API functions, defaults do nothing
 */
@@ -179,6 +180,12 @@ class RteCallback : public XMLTreeCallback
     MergeFiles(curFile, newFile);
   };
 
+  /**
+   * @brief obtains globally defined generator
+   * @param id generator id
+   * @return pointer to RteGenerator if found, nullptr otherwise
+  */
+  virtual RteGenerator* GetGenerator(const std::string& id) const { return nullptr; }
 
   /**
    * @brief get global RteCallback object

diff --git a/libs/rtemodel/src/RteComponent.cpp b/libs/rtemodel/src/RteComponent.cpp
@@ -305,13 +305,18 @@ RteApi* RteComponent::GetApi(RteTarget* target, bool matchVersion) const
 
 RteGenerator* RteComponent::GetGenerator() const
 {
+  RteGenerator* generator = nullptr;
   const string& generatorName = GetGeneratorName();
   if (!generatorName.empty()) {
     RtePackage* pack = GetPackage();
-    if (pack)
-      return pack->GetGenerator(generatorName);
+    if (pack) {
+      generator = pack->GetGenerator(generatorName);
+    }
+    if (!generator && GetCallback()) {
+      generator = GetCallback()->GetGenerator(generatorName);
+    }
   }
-  return nullptr;
+  return generator;
 }
 
 string RteComponent::GetGpdscFile(RteTarget* target) const

diff --git a/libs/rtemodel/test/src/RteChkTest.cpp b/libs/rtemodel/test/src/RteChkTest.cpp
@@ -30,9 +30,9 @@ Generic: 3\n\
 DFP: 3\n\
 BSP: 1\n\
 \n\
-Components: 52\n\
+Components: 53\n\
 From generic packs: 31\n\
-From DFP: 21\n\
+From DFP: 22\n\
 From BSP: 0\n\
 \n\
 Devices: 10\n\
@@ -51,7 +51,7 @@ completed\n";
   int res = rteChk.RunCheckRte();
   EXPECT_EQ(res, 0);
   EXPECT_EQ(rteChk.GetPackCount(), 7);
-  EXPECT_EQ(rteChk.GetComponentCount(), 52);
+  EXPECT_EQ(rteChk.GetComponentCount(), 53);
   EXPECT_EQ(rteChk.GetDeviceCount(), 10);
   EXPECT_EQ(rteChk.GetBoardCount(), 13);
 

diff --git a/libs/rtemodel/test/src/RteModelTest.cpp b/libs/rtemodel/test/src/RteModelTest.cpp
@@ -23,6 +23,30 @@
 
 using namespace std;
 
+
+class ExtGenRteCallback : public RteCallback
+{
+
+public:
+  ExtGenRteCallback() :m_pExtGenerator(nullptr) {
+    m_pExtGenerator = new RteGenerator(nullptr);
+    m_pExtGenerator->SetTag("generator");
+    m_pExtGenerator->AddAttribute("id", "RteTestExternalGenerator");
+    m_pExtGenerator->Construct();
+  }
+  ~ExtGenRteCallback() override{
+    delete m_pExtGenerator;
+  }
+  RteGenerator* GetGenerator(const std::string& id) const override {
+     if (m_pExtGenerator->GetID() == "RteTestExternalGenerator") {
+       return m_pExtGenerator;
+     }
+     return nullptr;
+   }
+
+  RteGenerator* m_pExtGenerator;
+};
+
 TEST(RteModelTest, LoadPacks) {
 
   RteKernelSlim rteKernel;  // here just to instantiate XMLTree parser
@@ -156,6 +180,23 @@ TEST(RteModelTest, LoadPacks) {
   c = rteModel->FindComponents(item, components);
   EXPECT_EQ(components.size(), 0);
   EXPECT_FALSE(c != nullptr);
+
+  item.SetAttributes({ {"Cclass","RteTestGenerator" },
+                       {"Cgroup", "Check Global Generator" },
+                       {"Cversion","0.9.0"}});
+  packInfo.SetPackId("ARM::RteTestGenerator");
+  item.SetPackageAttributes(packInfo);
+  components.clear();
+  c = rteModel->FindComponents(item, components);
+  ASSERT_TRUE(c != nullptr);
+  RteGenerator* gen = c->GetGenerator();
+  EXPECT_FALSE(gen != nullptr);
+
+  ExtGenRteCallback extGenRteCallback;
+  rteKernel.SetRteCallback(&extGenRteCallback);
+  gen = c->GetGenerator();
+  EXPECT_TRUE(gen != nullptr);
+  EXPECT_TRUE(gen == extGenRteCallback.m_pExtGenerator);
 }
 
 class RteModelPrjTest : public RteModelTestConfig

diff --git a/test/packs/ARM/RteTestGenerator/0.1.0/ARM.RteTestGenerator.pdsc b/test/packs/ARM/RteTestGenerator/0.1.0/ARM.RteTestGenerator.pdsc
@@ -184,6 +184,10 @@
     <component generator="RteTestGeneratorNoDryRun" Cclass="Device" Cgroup="RteTest Generated Component" Csub="RteTestNoDryRun" Cversion="1.1.0">
       <description>Configuration via RteTest script</description>
     </component>
+    <component generator="RteTestExternalGenerator" Cclass="RteTestGenerator" Cgroup="Check Global Generator" Cversion="0.9.0">
+      <description>Component addressing external</description>
+    </component>
+
     <bundle Cbundle="RteTestBundle" Cclass="Device" Cversion="1.0.0">
       <component generator="RteTestGeneratorIdentifier" Cgroup="RteTest Generated Component" Cversion="1.1.0">
         <description>Configuration via RteTest script</description>

diff --git a/tools/projmgr/test/src/ProjMgrUnitTests.cpp b/tools/projmgr/test/src/ProjMgrUnitTests.cpp
@@ -2779,7 +2779,8 @@ TEST_F(ProjMgrUnitTests, ListComponents_MultiplePackSelection) {
     "ARM::Device:RteTest Generated Component:[email protected] (ARM::[email protected])",
     "ARM::Device:RteTest Generated Component:[email protected] (ARM::[email protected])",
     "ARM::Device:RteTest Generated Component:[email protected] (ARM::[email protected])",
-    "ARM::Device:RteTest Generated Component:[email protected] (ARM::[email protected])"
+    "ARM::Device:RteTest Generated Component:[email protected] (ARM::[email protected])",
+    "ARM::RteTestGenerator:Check Global [email protected] (ARM::[email protected])"
   };
   vector<string> components;
   m_csolutionFile = testinput_folder + "/TestSolution/pack_contexts.csolution.yml";