ProjMgr: in silence mode only output to string buffers

Author: edriouk

libs/rtefsutils/src/RteFsUtils.cpp

@@ -549,10 +549,6 @@ fs::path RteFsUtils::AbsolutePath(const std::string& path) {
       return fs::absolute(path);
     }
     catch (fs::filesystem_error const& e) {
-      std::cout << "runtime_error: " << e.what() << std::endl;
-    }
-    catch (...) {
-      std::cout << "non-standard exception occurred" << std::endl;
     }
   }
   return fs::path();
@@ -886,7 +882,7 @@ bool RteFsUtils::FindFileWithPattern(const std::string& searchDir,
     }
   }
   catch (const std::exception& e) {
-    std::cout << "error: " << e.what() << std::endl;
+    // do nothing, anyway it is false
   }
   return false; // No matching file found
 }

libs/rteutils/include/CollectionUtils.h

@@ -31,6 +31,23 @@ typename M::mapped_type get_or_default(const M& m, const typename M::key_type& k
     return v;
 }
 
+/**
+ * @brief Returns reference to value stored in a map for a given key or default value reference if no entry is found
+ * @param M template parameter representing a map
+ * @param m a key-value map
+ * @param k key to search for
+ * @param v default value
+ * @return stored value if found, default value otherwise
+*/
+template<typename M>
+typename M::mapped_type const& get_or_default_const_ref(const M& m, const typename M::key_type& k, const typename M::mapped_type& v) {
+    auto itr = m.find(k);
+    if (itr != m.end()) {
+        return itr->second;
+    }
+    return v;
+}
+
 /**
  * @brief Returns value stored in a map for a given key or nullptr
  * @tparam M template parameter representing a map with the value of pointer type

tools/projmgr/include/ProjMgrLogger.h

@@ -9,6 +9,7 @@
 
 #include <map>
 #include <string>
+#include <sstream>
 #include <vector>
 
 /**
@@ -58,37 +59,86 @@ class ProjMgrLogger {
   void Info(const std::string& msg, const std::string& context = std::string(),
     const std::string& file = std::string(), const int line = 0, const int column = 0);
 
-  /**
+ /**
    * @brief print debug
    * @param message
   */
   static void Debug(const std::string& msg);
 
+  /**
+   * @brief returns reference to active output stream: cout (default) or string buffer (in silent mode)
+   * @return reference to active output stream
+  */
+  static std::ostream& out();
 
+  /**
+   * @brief check if in quiet mode
+   * @return true if quiet or silent
+  */
+  static bool IsQuiet() { return m_quiet || m_silent; }
+
+  /**
+  * @brief flag to suppress infos and warnings
+  */
   static bool m_quiet;
 
+ /**
+  * @brief flag to suppress all output and redirect cout to string buffer
+  */
+  static bool m_silent;
+
+
   /**
    * @brief get errors
    * @return reference to errors map
   */
-  std::map<std::string, std::vector<std::string>>& GetErrors() { return m_errors; }
+  const std::map<std::string, std::vector<std::string>>& GetErrors() const { return m_errors; }
 
   /**
    * @brief get warnings
    * @return reference to warnings map
   */
-  std::map<std::string, std::vector<std::string>>& GetWarns() { return m_warns; }
+  const std::map<std::string, std::vector<std::string>>& GetWarns() const { return m_warns; }
 
   /**
    * @brief get info messages
    * @return reference to info messages map
   */
-  std::map<std::string, std::vector<std::string>>& GetInfos() { return m_infos; }
+  const std::map<std::string, std::vector<std::string>>& GetInfos() const { return m_infos; }
+
+
+  /**
+   * @brief get errors
+   * @return reference to errors map
+  */
+  const std::vector<std::string>& GetErrorsForContext(const std::string& context = std::string()) const;
+
+  /**
+   * @brief get warnings
+   * @return reference to warnings map
+  */
+  const std::vector<std::string>& GetWarnsForContext(const std::string& context = std::string()) const;
+
+  /**
+   * @brief get info messages
+   * @return reference to info messages map
+  */
+  const std::vector<std::string>& GetInfosForContext(const std::string& context = std::string()) const;
+
+
+  /**
+   * @brief get sting stream
+   * @return reference to internal string stream
+  */
+  const std::ostringstream& GetStringStream() const { return m_ss; }
 
 protected:
   std::map<std::string, std::vector<std::string>> m_errors;
   std::map<std::string, std::vector<std::string>> m_warns;
   std::map<std::string, std::vector<std::string>> m_infos;
+
+  std::ostringstream m_ss; // stream for unsorted messages sent directly to output
+
 };
 
 #endif  // PROJMGRLOGGER_H

tools/projmgr/src/ProjMgr.cpp

@@ -90,8 +90,8 @@ bool ProjMgr::PrintUsage(
   string signature = string("csolution: Project Manager ") + VERSION_STRING + string(" ") + COPYRIGHT_NOTICE;
   if (cmd.empty() && subCmd.empty()) {
     // print main help
-    cout << signature << endl;
-    cout << USAGE << endl;
+    ProjMgrLogger::out() << signature << endl;
+    ProjMgrLogger::out() << USAGE << endl;
     return true;
   }
 
@@ -102,7 +102,7 @@ bool ProjMgr::PrintUsage(
   }
 
   // print command help
-  cout << signature << endl;
+  ProjMgrLogger::out() << signature << endl;
   auto [optionalArg, cmdOptions] = cmdOptionsDict.at(filter);
 
   string program = ORIGINAL_FILENAME + string(" ") + cmd +
@@ -123,12 +123,12 @@ bool ProjMgr::PrintUsage(
     options.custom_help(RteUtils::EMPTY_STRING);
   }
 
-  cout << options.help() << endl;
+  ProjMgrLogger::out() << options.help() << endl;
   return true;
 }
 
 void ProjMgr::ShowVersion(void) {
-  cout << ORIGINAL_FILENAME << " " << VERSION_STRING << " " << COPYRIGHT_NOTICE << endl;
+  ProjMgrLogger::out() << ORIGINAL_FILENAME << " " << VERSION_STRING << " " << COPYRIGHT_NOTICE << endl;
 }
 
 int ProjMgr::ParseCommandLine(int argc, char** argv) {
@@ -733,7 +733,7 @@ bool ProjMgr::RunListPacks(void) {
   vector<string> packs;
   bool ret = m_worker.ListPacks(packs, m_missingPacks, m_filter);
   for (const auto& pack : packs) {
-    cout << pack << endl;
+    ProjMgrLogger::out() << pack << endl;
   }
   return ret;
 }
@@ -757,7 +757,7 @@ bool ProjMgr::RunListBoards(void) {
     return false;
   }
   for (const auto& device : boards) {
-    cout << device << endl;
+    ProjMgrLogger::out() << device << endl;
   }
   return true;
 }
@@ -781,7 +781,7 @@ bool ProjMgr::RunListDevices(void) {
     return false;
   }
   for (const auto& device : devices) {
-    cout << device << endl;
+    ProjMgrLogger::out() << device << endl;
   }
   return true;
 }
@@ -806,7 +806,7 @@ bool ProjMgr::RunListComponents(void) {
   }
 
   for (const auto& component : components) {
-    cout << component << endl;
+    ProjMgrLogger::out() << component << endl;
   }
   return true;
 }
@@ -829,7 +829,7 @@ bool ProjMgr::RunListConfigs() {
   }
 
   for (const auto& configFile : configFiles) {
-    cout << configFile << endl;
+    ProjMgrLogger::out() << configFile << endl;
   }
   return true;
 }
@@ -852,7 +852,7 @@ bool ProjMgr::RunListDependencies(void) {
   }
 
   for (const auto& dependency : dependencies) {
-    cout << dependency << endl;
+    ProjMgrLogger::out() << dependency << endl;
   }
   return true;
 }
@@ -868,7 +868,7 @@ bool ProjMgr::RunListContexts(void) {
     return false;
   }
   for (const auto& context : contexts) {
-    cout << context << endl;
+    ProjMgrLogger::out() << context << endl;
   }
   return true;
 }
@@ -891,7 +891,7 @@ bool ProjMgr::RunListGenerators(void) {
   }
 
   for (const auto& generator : generators) {
-    cout << generator << endl;
+    ProjMgrLogger::out() << generator << endl;
   }
   return true;
 }
@@ -930,7 +930,7 @@ bool ProjMgr::RunListLayers(void) {
 
   if (!m_updateIdx) {
     for (const auto& layer : layers) {
-      cout << layer << endl;
+      ProjMgrLogger::out() << layer << endl;
     }
   }
 
@@ -986,7 +986,7 @@ bool ProjMgr::RunCodeGenerator(void) {
       return false;
     }
   }
-  
+
   if (m_worker.HasToolchainErrors()) {
     return false;
   }
@@ -1027,7 +1027,7 @@ bool ProjMgr::RunListToolchains(void) {
     toolchainsSet.insert(toolchainEntry);
   }
   for (const auto& toolchainEntry : toolchainsSet) {
-    cout << toolchainEntry;
+    ProjMgrLogger::out() << toolchainEntry;
   }
   // If the worker has toolchain errors, set the success flag to false
   if (m_worker.HasToolchainErrors()) {
@@ -1040,11 +1040,11 @@ bool ProjMgr::RunListEnvironment(void) {
   string notFound = "<Not Found>";
   EnvironmentList env;
   m_worker.ListEnvironment(env);
-  cout << "CMSIS_PACK_ROOT=" << (env.cmsis_pack_root.empty() ? notFound : env.cmsis_pack_root) << endl;
-  cout << "CMSIS_COMPILER_ROOT=" << (env.cmsis_compiler_root.empty() ? notFound : env.cmsis_compiler_root) << endl;
+  ProjMgrLogger::out() << "CMSIS_PACK_ROOT=" << (env.cmsis_pack_root.empty() ? notFound : env.cmsis_pack_root) << endl;
+  ProjMgrLogger::out() << "CMSIS_COMPILER_ROOT=" << (env.cmsis_compiler_root.empty() ? notFound : env.cmsis_compiler_root) << endl;
   CrossPlatformUtils::REG_STATUS status = CrossPlatformUtils::GetLongPathRegStatus();
   if (status != CrossPlatformUtils::REG_STATUS::NOT_SUPPORTED) {
-    cout << "Long pathname support=" <<
+    ProjMgrLogger::out() << "Long pathname support=" <<
       (status == CrossPlatformUtils::REG_STATUS::ENABLED ? "enabled" : "disabled") << endl;
   }
   return true;

tools/projmgr/src/ProjMgrCbuildIdx.cpp

@@ -142,7 +142,7 @@ ProjMgrCbuildIdx::ProjMgrCbuildIdx(YAML::Node node,
       }
 
       // errors, warnings and info messages
-      const vector<pair<StrVecMap&, const char*>> messages = {
+      const vector<pair<const StrVecMap&, const char*>> messages = {
         { ProjMgrLogger::Get().GetErrors(), YAML_ERRORS },
         { ProjMgrLogger::Get().GetWarns(), YAML_WARNINGS },
         { ProjMgrLogger::Get().GetInfos(), YAML_INFO },