Support for external generators in RTE Model (#1309)

* Support for external generators in RTE Model read .generator.yml files make some common code accessible from different tools remove duplicated methods read generators.yml in RTE Model move ExecCommand to CrossPlatformUtils move constants to RteConstants move some utility methods to CollectionUtils rename RteFsUtils::CreateFile to RteFsUtils::CreateTextFile due to clash with Windows API --------- Co-authored-by: Evgueni Driouk <edriouk@arm.com>
Open-CMSIS-Pack · Feb 2, 2024 · 8b3b1eb · 8b3b1eb
1 parent 5572be9
commit 8b3b1eb
Show file tree

Hide file tree

Showing 61 changed files with 995 additions and 895 deletions.
diff --git a/libs/crossplatform/include/CrossPlatformUtils.h b/libs/crossplatform/include/CrossPlatformUtils.h
@@ -84,6 +84,13 @@ class CrossPlatformUtils
   */
   static bool CanExecute(const std::string& file);
 
+  /**
+   * @brief execute shell command
+   * @param cmd string shell command to be executed
+   * @return command execution result <string, error_code>
+  */
+  static const std::pair<std::string, int> ExecCommand(const std::string& cmd);
+
   enum class REG_STATUS {
     ENABLED,
     DISABLED,

diff --git a/libs/crossplatform/src/CrossPlatformUtils.cpp b/libs/crossplatform/src/CrossPlatformUtils.cpp
@@ -4,9 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 #include "CrossPlatformUtils.h"
+#include "CrossPlatform.h"
 #include "constants.h"
 
 #include <time.h>
+#include <array>
+#include <functional>
 
 std::string CrossPlatformUtils::GetEnv(const std::string& name)
 {
@@ -64,4 +67,25 @@ const std::string& CrossPlatformUtils::GetHostType()
   return os_name;
 }
 
+
+const std::pair<std::string, int> CrossPlatformUtils::ExecCommand(const std::string& cmd)
+{
+  std::array<char, 128> buffer;
+  std::string result;
+  int ret_code = -1;
+  std::function<int(FILE*)> close = _pclose;
+  std::function<FILE* (const char*, const char*)> open = _popen;
+
+  auto deleter = [&close, &ret_code](FILE* cmd) { ret_code = close(cmd); };
+  {
+    const std::unique_ptr<FILE, decltype(deleter)> pipe(open(cmd.c_str(), "r"), deleter);
+    if (pipe) {
+      while (fgets(buffer.data(), static_cast<int>(buffer.size()), pipe.get()) != nullptr) {
+        result += buffer.data();
+      }
+    }
+  }
+  return std::make_pair(result, ret_code);
+}
+
 // end of CrossplatformUtils.cpp
diff --git a/libs/crossplatform/test/src/UnitTests.cpp b/libs/crossplatform/test/src/UnitTests.cpp
@@ -107,4 +107,19 @@ TEST(CrossPlatformUnitTests, GetLongPathRegStatus) {
     EXPECT_EQ(CrossPlatformUtils::REG_STATUS::NOT_SUPPORTED, status);
   }
 }
+
+TEST(CrossPlatformUnitTests, ExecCommand) {
+  auto result = CrossPlatformUtils::ExecCommand("invalid command");
+  EXPECT_EQ(false, (0 == result.second) ? true : false) << result.first;
+
+  string testdir = "mkdir_test_dir";
+  error_code ec;
+  if (filesystem::exists(testdir)) {
+    filesystem::remove(testdir);
+  }
+  result = CrossPlatformUtils::ExecCommand("mkdir " + testdir);
+  EXPECT_TRUE(filesystem::exists(testdir));
+  EXPECT_EQ(true, (0 == result.second) ? true : false) << result.first;
+}
+
 // end of UnitTests.cpp
diff --git a/libs/rtefsutils/include/RteFsUtils.h b/libs/rtefsutils/include/RteFsUtils.h
@@ -8,7 +8,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
  */
@@ -66,7 +66,7 @@ class RteFsUtils
    * @param content string to be stored in the created file
    * @return true if file is created
   */
-  static bool CreateFile(const std::string& file, const std::string& content);
+  static bool CreateTextFile(const std::string& file, const std::string& content);
   /**
    * @brief copy string to file in binary mode. Previous content of file is destroyed.
    * @param fileName name of file
@@ -377,6 +377,14 @@ class RteFsUtils
    * @return absolute file name if found, empty string otherwise
   */
   static std::string FindFileInEtc(const std::string& fileName, const std::string& baseDir);
+
+   /**
+   * @brief get file category according to file extension
+   * @param filename with extension
+   * @return string category
+  */
+  static const std::string& FileCategoryFromExtension(const std::string& file);
+
 };
 
 #endif // RteFsUtils_H
diff --git a/libs/rtefsutils/src/RteFsUtils.cpp b/libs/rtefsutils/src/RteFsUtils.cpp
@@ -203,7 +203,7 @@ string RteFsUtils::BackupFile(const string& fileName, bool bDeleteExisting) {
   return RteUtils::ERROR_STRING;
 }
 
-bool RteFsUtils::CreateFile(const string& file, const string& content) {
+bool RteFsUtils::CreateTextFile(const string& file, const string& content) {
   // Create file and directories
   error_code ec;
   fs::create_directories(fs::path(file).parent_path(), ec);
@@ -233,7 +233,7 @@ bool RteFsUtils::CopyBufferToFile(const string& fileName, const string& buffer,
     }
   }
 
-  return CreateFile(fileName, buffer);
+  return CreateTextFile(fileName, buffer);
 }
 
 bool RteFsUtils::CopyMergeFile(const string& src, const string& dst, int nInstance, bool backup) {
@@ -729,7 +729,8 @@ void RteFsUtils::GetMatchingFiles(list<string>& files, const string& extension,
     const fs::path& p = entry.path();
     string filename = p.filename().generic_string();
     if (fs::is_regular_file(p)) {
-      if (p.extension() == extension) {
+      auto pos = filename.rfind(extension);
+      if (pos != string::npos && pos == (filename.size() - extension.size())) {
         files.push_back(p.generic_string()); // insert full absolute path
         bFound = true;
       }
@@ -840,4 +841,25 @@ std::string RteFsUtils::FindFileInEtc(const std::string& fileName, const std::st
   return FindFile(fileName, baseDir, relSearchOrder);
 }
 
+const string& RteFsUtils::FileCategoryFromExtension(const string& file) {
+  static const string& OTHER = "other";
+  static const map<string, vector<string>> CATEGORIES = {
+    {"sourceC", {".c", ".C"}},
+    {"sourceCpp", {".cpp", ".c++", ".C++", ".cxx", ".cc", ".CC"}},
+    {"sourceAsm", {".asm", ".s", ".S"}},
+    {"header", {".h", ".hpp"}},
+    {"library", {".a", ".lib"}},
+    {"object", {".o"}},
+    {"linkerScript", {".sct", ".scf", ".ld", ".icf", ".src"}},
+    {"doc", {".txt", ".md", ".pdf", ".htm", ".html"}},
+  };
+  fs::path ext((fs::path(file)).extension());
+  for (const auto& category : CATEGORIES) {
+    if (find(category.second.begin(), category.second.end(), ext) != category.second.end()) {
+      return category.first;
+    }
+  }
+  return OTHER;
+}
+
 // End of RteFsUtils.cpp