RteKernel to provide YmlTree parser (#1286)

* RteKernel to provide YmlTree parser * YmlTree parser find schema files allow override YmlTreeParserInterface * RteKernel set/get path to CMSIS-Toolbox Installation --------- Co-authored-by: Evgueni Driouk <[email protected]>
Open-CMSIS-Pack · Jan 19, 2024 · 9f286aa · 9f286aa
1 parent 76d2052
commit 9f286aa
Show file tree

Hide file tree

Showing 26 changed files with 334 additions and 231 deletions.
diff --git a/libs/rtefsutils/include/RteFsUtils.h b/libs/rtefsutils/include/RteFsUtils.h
@@ -359,6 +359,24 @@ class RteFsUtils
    * @return string containing the absolute path
   */
   static std::string GetAbsPathFromLocalUrl(const std::string& url);
+
+  /**
+   * @brief finds file in directories relative to the base path
+   * @param fileName file name to search for
+   * @param baseDir path to look in
+   * @param relSearchOrder vector of relative directories to look in
+   * @return absolute file name if found, empty string otherwise
+  */
+  static std::string FindFile(const std::string& fileName, const std::string& baseDir,
+    const std::vector<std::string>& relSearchOrder);
+
+  /**
+   * @brief finds file in  ./, ../etc/, and ../../etc directories relative to the base
+   * @param fileName file name to search for
+   * @param baseDir path to look in
+   * @return absolute file name if found, empty string otherwise
+  */
+  static std::string FindFileInEtc(const std::string& fileName, const std::string& baseDir);
 };
 
 #endif // RteFsUtils_H
diff --git a/libs/rtefsutils/src/RteFsUtils.cpp b/libs/rtefsutils/src/RteFsUtils.cpp
@@ -822,4 +822,22 @@ string RteFsUtils::GetAbsPathFromLocalUrl(const string& url) {
   return filepath;
 }
 
+std::string RteFsUtils::FindFile(const std::string& fileName, const std::string& baseDir,
+  const std::vector<std::string>& relSearchOrder)
+{
+  for(auto& relPath : relSearchOrder) {
+    string file = baseDir + relPath + fileName;
+    if(RteFsUtils::Exists(file)) {
+      return MakePathCanonical(file);
+    }
+  }
+  return RteUtils::EMPTY_STRING;
+}
+
+std::string RteFsUtils::FindFileInEtc(const std::string& fileName, const std::string& baseDir)
+{
+  static const std::vector<std::string>& relSearchOrder = { "./", "../etc/", "../../etc/" };
+  return FindFile(fileName, baseDir, relSearchOrder);
+}
+
 // End of RteFsUtils.cpp
diff --git a/libs/rtemodel/CMakeLists.txt b/libs/rtemodel/CMakeLists.txt
@@ -21,4 +21,4 @@ set_property(TARGET RteModel PROPERTY
 
 target_include_directories(RteModel PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
 
-target_link_libraries(RteModel RteFsUtils RteUtils XmlTree CrossPlatform)
+target_link_libraries(RteModel RteFsUtils RteUtils XmlTree YmlTree CrossPlatform)
diff --git a/libs/rtemodel/include/RteKernel.h b/libs/rtemodel/include/RteKernel.h
@@ -18,7 +18,7 @@
 #include "RteTarget.h"
 #include "RteUtils.h"
 
-#include "XMLTree.h"
+#include "YmlTree.h"
 
 #include <memory>
 
@@ -57,6 +57,19 @@ class RteKernel
   */
   bool SetCmsisPackRoot(const std::string& cmsisPackRoot);
 
+  /**
+   * @brief getter for CMSIS-Toolbox installation directory
+   * @return CMSIS-Toolbox installation directory if available
+  */
+  const std::string& GetCmsisToolboxDir() const { return m_cmsisToolboxDir; }
+
+  /**
+   * @brief setter for CMSIS-Toolbox installation directory
+   * @param cmsisToolboxDir CMSIS-Toolbox installation directory to set
+  */
+  void SetCmsisToolboxDir(const std::string& cmsisToolboxDir) { m_cmsisToolboxDir = cmsisToolboxDir; }
+
+
   /**
    * @brief getter for RteCallback object
    * @return pointer to RteCallback object
@@ -218,11 +231,19 @@ class RteKernel
   std::string GetPdscFileFromPath(const XmlItem& attributes, const std::string& cprjPath, std::string& packId);
 
   /**
-   * @brief create a smart pointer holding a XMLTree pointer
-   * @return a std::unique_ptr object holding a XMLTree pointer which is nullptr in the default implementation
+   * @brief create a smart pointer holding an XMLTree pointer to parse XML files
+   * @param itemBuilder pointer to IXmlItemBuilder item factory
+   * @return a std::unique_ptr object holding an XMLTree-derived pointer which is nullptr in the default implementation
   */
   virtual std::unique_ptr<XMLTree> CreateUniqueXmlTree(IXmlItemBuilder* itemBuilder = nullptr) const;
 
+  /**
+   * @brief create a smart pointer holding a YmlTree pointer to parse YAML files
+   * @param itemBuilder pointer to IXmlItemBuilder item factory
+   * @return a std::unique_ptr object holding a YmlTree-derived pointer which is nullptr in the default implementation
+  */
+  virtual std::unique_ptr<YmlTree> CreateUniqueYmlTree(IXmlItemBuilder* itemBuilder = nullptr) const;
+
   /**
    * @brief save active project into cprj file
    * @param file cprj file name
@@ -274,7 +295,19 @@ class RteKernel
   bool GetLocalPacksUrls(const std::string& rtePath, std::list<std::string>& urls) const;
   XMLTreeElement* ParseLocalRepositoryIdx(const std::string& rtePath) const;
 
-  virtual XMLTree* CreateXmlTree(IXmlItemBuilder* itemBuilder) const { return nullptr; } // creates new XMLTree implementation
+  /**
+   * @brief create an XMLTree object to parse XML files
+   * @param itemBuilder pointer to IXmlItemBuilder item factory
+   * @return XMLTree-derived pointer which is nullptr in the default implementation
+  */
+  virtual XMLTree* CreateXmlTree(IXmlItemBuilder* itemBuilder) const { return nullptr; }
+
+  /**
+   * @brief create a YmlTree object to parse YAML files
+   * @param itemBuilder pointer to IXmlItemBuilder item factory
+   * @return YmlTree-derived pointer
+  */
+  virtual YmlTree* CreateYmlTree(IXmlItemBuilder* itemBuilder) const;
 
 protected:
   /**
@@ -288,5 +321,6 @@ class RteKernel
   RteCallback* m_rteCallback;
   XmlItem m_toolInfo;
   std::string m_cmsisPackRoot;
+  std::string m_cmsisToolboxDir;
 };
 #endif // RteKernel_H
diff --git a/libs/rtemodel/src/RteKernel.cpp b/libs/rtemodel/src/RteKernel.cpp
@@ -21,6 +21,7 @@
 #include "RteUtils.h"
 #include "RteFsUtils.h"
 #include "XmlFormatter.h"
+#include "YmlFormatter.h"
 
 using namespace std;
 
@@ -560,4 +561,15 @@ unique_ptr<XMLTree> RteKernel::CreateUniqueXmlTree(IXmlItemBuilder* itemBuilder)
   return xmlTree;
 }
 
+unique_ptr<YmlTree> RteKernel::CreateUniqueYmlTree(IXmlItemBuilder* itemBuilder) const
+{
+  unique_ptr<YmlTree> ymlTree(CreateYmlTree(itemBuilder));
+  return ymlTree;
+}
+
+YmlTree* RteKernel::CreateYmlTree(IXmlItemBuilder* itemBuilder) const
+{
+  return new YmlTree(itemBuilder);
+}
+
 // End of RteKernel.cpp
diff --git a/libs/rteutils/include/ISchemaChecker.h b/libs/rteutils/include/ISchemaChecker.h
@@ -8,6 +8,7 @@
 #define ISCHEMA_CHECKER_H
 
 #include "RteError.h"
+#include "RteUtils.h"
 #include <list>
 
 /**
@@ -29,6 +30,20 @@ class ISchemaChecker
   */
   virtual bool ValidateFile(const std::string& file, const std::string& schemaFile) = 0;
 
+  /**
+   * @brief Validates a file against schema obtained by FindSchema() method
+   * @param fileName file to validate
+   * @return true if successful
+  */
+  virtual bool Validate(const std::string& file) { return ValidateFile(file, FindSchema(file)); }
+
+  /**
+   * @brief Finds schema for given file to validate
+   * @param fileName file to validate
+   * @return schema file name if found, empty string otherwise
+  */
+  virtual std::string FindSchema(const std::string& file) const { return RteUtils::EMPTY_STRING; }
+
   /**
    * @brief returns collection of error messages found during last run of validate
   */

diff --git a/libs/xmltree/include/XMLTree.h b/libs/xmltree/include/XMLTree.h
@@ -11,7 +11,7 @@
 */
 /******************************************************************************/
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -347,7 +347,7 @@ class XMLTree : public  XMLTreeElement
    * @param xmlString buffer containing XML formatted text
    * @return true if buffer is successfully parsed
   */
-  bool ParseXmlString(const std::string& xmlString);
+  bool ParseString(const std::string& xmlString);
 
   /**
    * @brief parse either file or buffer containing XML formatted text
@@ -401,6 +401,11 @@ class XMLTree : public  XMLTreeElement
 protected:
   // parses file or XML sting (fileName can be used to associate parsed document with the file)
   bool DoParse(const std::string& fileName, const std::string& xmlString);
+  /**
+   * @brief creates underling parser interface
+   * @return XMLTreeParserInterface;
+  */
+  virtual XMLTreeParserInterface* CreateParserInterface() = 0;
 
 protected:
   std::string m_schemaFile; // schema file with path

diff --git a/libs/xmltree/src/XMLTree.cpp b/libs/xmltree/src/XMLTree.cpp
@@ -1,6 +1,6 @@
 /******************************************************************************/
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -120,7 +120,13 @@ void XMLTree::SetIgnoreTags(const set<string>& ignoreTags)
 
 bool XMLTree::Init()
 {
-  return m_p->Init();
+  if(!m_p) {
+    m_p = CreateParserInterface();
+  }
+  if(m_p) {
+    return m_p->Init();
+  }
+  return false;
 }
 
 
@@ -173,30 +179,36 @@ bool XMLTree::ParseAll()
 
 bool XMLTree::ParseFile(const string& fileName)
 {
-  if(m_schemaChecker && !m_schemaFile.empty()) {
-    m_schemaChecker->ClearErrors();
-    if(!m_schemaChecker->ValidateFile(fileName, m_schemaFile)) {
-      for(auto& err : m_schemaChecker->GetErrors()) {
-        if(err.m_severity == RteError::SevERROR) {
-          m_nErrors++;
-        } else if(err.m_severity == RteError::SevWARNING) {
-          m_nWarnings++;
+  if(m_schemaChecker ) {
+    const string& schema = m_schemaFile.empty() ? m_schemaChecker->FindSchema(fileName) : m_schemaFile;
+    if(!schema.empty()) {
+      m_schemaChecker->ClearErrors();
+      if(!m_schemaChecker->ValidateFile(fileName, m_schemaFile)) {
+        for(auto& err : m_schemaChecker->GetErrors()) {
+          if(err.m_severity == RteError::SevERROR) {
+            m_nErrors++;
+          } else if(err.m_severity == RteError::SevWARNING) {
+            m_nWarnings++;
+          }
+          m_errorStrings.push_back(err.ToString());
         }
-        m_errorStrings.push_back(err.ToString());
+        return false;
       }
-      return false;
     }
   }
   return Parse(fileName, EMPTY_STRING);
 }
 
 
-bool XMLTree::ParseXmlString(const std::string& xmlString) {
+bool XMLTree::ParseString(const std::string& xmlString) {
   return Parse(EMPTY_STRING, xmlString);
 }
 
 bool XMLTree::Parse(const std::string& fileName, const std::string& xmlString)
 {
+  if(!Init()) {
+    return false;
+  }
   m_p->Clear();
   return DoParse(fileName, xmlString);
 }

diff --git a/libs/xmltree/test/src/XmlFormatterTest.cpp b/libs/xmltree/test/src/XmlFormatterTest.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -14,6 +14,8 @@ class XMLTreeDummy : public  XMLTree
 {
 public:
   XMLTreeDummy(IXmlItemBuilder* itemBuilder = NULL) : XMLTree(itemBuilder) {}
+protected:
+  XMLTreeParserInterface* CreateParserInterface() override { return nullptr; }
 };
 
 static const string xmlSchemaFile = "CPRJ.xsd";
@@ -84,6 +86,10 @@ static const string jsonResExpected = string("{\n") +
 "}\n";
 
 
+TEST(XMLTree, CannotParseWithoutInterface) {
+  auto tree = make_unique<XMLTreeDummy>();
+  EXPECT_FALSE(tree->ParseString(xmlResExpected));
+}
 
 
 TEST(XMLFormatterTest, HeaderAndContentTest)

diff --git a/libs/xmltreeslim/include/XMLTreeSlim.h b/libs/xmltreeslim/include/XMLTreeSlim.h
@@ -3,17 +3,17 @@
 /******************************************************************************/
 /** @file  XmlTreeSlim.h
   * @brief A simple XML interface that reads data into a tree structure
-  * @uses XmlReader  	
-*/ 
+  * @uses XmlReader
+*/
 /******************************************************************************/
 /*
   * The reader should be kept semantics-free:
   * no special processing based on tag, attribute or value string
 */
 /******************************************************************************/
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
- * 
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
+ *
  * SPDX-License-Identifier: Apache-2.0
  */
 /******************************************************************************/
@@ -35,6 +35,12 @@ class XMLTreeSlim : public  XMLTree
    * @param bIgnoreAttributePrefixes true to ignore attribute prefixes otherwise false
   */
   XMLTreeSlim(IXmlItemBuilder* itemBuilder = NULL, bool bRedirectErrLog = false, bool bIgnoreAttributePrefixes = true);
+
+protected:
+  XMLTreeParserInterface* CreateParserInterface() override;
+  bool m_bRedirectErrLog;
+  bool m_bIgnoreAttributePrefixes;
+
 };
 
 #endif // XMLTreeSlim_H

diff --git a/libs/xmltreeslim/include/XMLTreeSlimString.h b/libs/xmltreeslim/include/XMLTreeSlimString.h
@@ -12,20 +12,20 @@
 */
 /******************************************************************************/
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
 /******************************************************************************/
 
-#include "XMLTree.h"
+#include "XMLTreeSlim.h"
 
 class IXmlItemBuilder;
 
 /**
  * @brief XML interface that reads data into a tree structure
 */
-class XMLTreeSlimString : public  XMLTree
+class XMLTreeSlimString : public  XMLTreeSlim
 {
 public:
   /**
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,4 +21,4 @@ set_property(TARGET RteModel PROPERTY

		target_include_directories(RteModel PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

		target_link_libraries(RteModel RteFsUtils RteUtils XmlTree CrossPlatform)
		target_link_libraries(RteModel RteFsUtils RteUtils XmlTree YmlTree CrossPlatform)