Debug Config file PLM

Author: spcaipers-arm

libs/rtemodel/include/CprjFile.h

@@ -19,7 +19,6 @@
 #include "RtePackage.h"
 #include "RteDevice.h"
 
-class RteFile;
 class RteFileContainer;
 class RteComponentContainer;
 class RteTarget;

libs/rtemodel/include/RteComponent.h

@@ -14,9 +14,7 @@
  */
 /******************************************************************************/
 #include "RteItem.h"
-#include "RteFile.h"
 
-class RteFile;
 class RteTarget;
 class RteFileContainer;
 class RtePackage;

libs/rtemodel/include/RteDevice.h

@@ -66,6 +66,12 @@ class RteDeviceElement : public RteItem
   */
    const std::string& GetVendorString() const override { return GetEffectiveAttribute("Dvendor"); }
 
+   /**
+   * @brief any item associated with a device is device-dependent
+   * @return true
+  */
+   bool IsDeviceDependent() const override { return true; }
+
   /**
    * @brief obtain for all effectively defined attributes of this device element. That is collection of all attributes defined in this element and in parent elements.
    * @param attributes reference to XmlItem to fill
@@ -657,12 +663,24 @@ class RteDeviceDebugVars : public RteDeviceProperty
   */
   RteDeviceDebugVars(RteItem* parent) : RteDeviceProperty(parent) {};
 
+  /**
+   * @brief returns name of the debug config file
+  */
+  const std::string& GetName() const override { return GetAttribute("configfile"); }
+
+   /**
+   * @brief returns true to indicate that associated configuration file is a config one and should be copied in project's RTE directory
+   * @return true
+  */
+  bool IsConfig() const override { return true; }
+
+
 protected:
   /**
    * @brief construct unique debugvars property ID
    * @return ID string
   */
-   std::string ConstructID() override { return RteDeviceProperty::ConstructID() + std::string(":") + GetProcessorName(); }
+   std::string ConstructID() override { return GetTag() + std::string(":") + GetProcessorName(); }
 };
 
 
@@ -1132,9 +1150,9 @@ class RteDevice : public RteDeviceItem
 public:
   /**
    * @brief constructor
-   * @param parent pointer to parent RteDeviceItem
+   * @param parent pointer to parent RteItem (usually RteDeviceItem)
   */
-  RteDevice(RteDeviceItem* parent) : RteDeviceItem(parent) {};
+  RteDevice(RteItem* parent) : RteDeviceItem(parent) {};
 
 public:
   /**

libs/rtemodel/include/RteExample.h

@@ -14,7 +14,6 @@
  */
 /******************************************************************************/
 #include "RteItem.h"
-#include "RteFile.h"
 
 /**
  * @brief class presenting an example project with related files and properties

libs/rtemodel/include/RteFile.h

@@ -103,11 +103,19 @@ class RteFile : public RteItem
    * @return true if GetRole() == RteFile::COPY
   */
   bool IsForcedCopy() const;
+
   /**
    * @brief check if file has config role
    * @return true if GetRole() == RteFile::CONFIG
   */
-  bool IsConfig() const;
+  bool IsConfig() const override;
+
+  /**
+     * @brief check if file is associated with a condition that depends on selected device or parent component is device dependent
+     * @return true if item's condition depends on selected device
+    */
+  bool IsDeviceDependent() const override;
+
   /**
    * @brief check if file is a template
    * @return true if GetRole() == RteFile::TEMPLATE
@@ -117,7 +125,7 @@ class RteFile : public RteItem
    * @brief check if file must be added to project
    * @return true if to add to project
   */
-  bool IsAddToProject() const;
+  bool IsAddToProject() const override;
 
   /**
    * @brief get file category
@@ -155,13 +163,12 @@ class RteFile : public RteItem
   */
    std::string ConstructID() override;
 
-  /**
+   /**
    * @brief get file name
    * @return file name
    */
   const std::string& GetName() const override;
 
-
   /**
    * @brief get file version string
    * @return "version" attribute value if set, otherwise parent component version
@@ -182,6 +189,7 @@ class RteFile : public RteItem
    * @param paths set of path strings
   */
   void GetAbsoluteSourcePaths(std::set<std::string>& paths) const;
+
   /**
    * @brief construct full path including filename for a file that should be used when adding file to a project
    * @param deviceName name of device used in the project
@@ -191,7 +199,7 @@ class RteFile : public RteItem
    * @param rteFolder the "RTE" folder path used for placing files
    * @return full project-relative path including filename and extension
   */
-  std::string GetInstancePathName(const std::string& deviceName, int instanceIndex, const std::string& rteFolder) const;
+  std::string GetInstancePathName(const std::string& deviceName, int instanceIndex, const std::string& rteFolder) const override;
 
   /**
    * @brief construct absolute include path string that can be used in'-I' compiler option.

libs/rtemodel/include/RteInstance.h

@@ -1406,25 +1406,25 @@ class RteFileInstance : public RteItemInstance
 public:
   /**
    * @brief initialize the file instance
-   * @param f pointer to the original RteFile
+   * @param f pointer to the original RteItem, represents RteFile or an item associated with a file
    * @param deviceName device name used in the target
    * @param instanceIndex instance index, can be > 0  for multi-instance components
    * @param rteFolder the "RTE" folder path used for placing files
   */
-  void Init(RteFile* f, const std::string& deviceName, int instanceIndex, const std::string& rteFolder);
+  void Init(RteItem* f, const std::string& deviceName, int instanceIndex, const std::string& rteFolder);
 
   /**
    * @brief update file instance
-   * @param f pointer to the original RteFile
+   * @param f pointer to the original RteFile or RteItem representing afile
    * @param bUpdateComponent update information about component this file belongs to
   */
-  void Update(RteFile* f, bool bUpdateComponent);
+  void Update(RteItem* f, bool bUpdateComponent);
 
   /**
    * @brief check if this file is a config one
    * @return true if "attr" attribute value is "config"
   */
-  bool IsConfig() const;
+  bool IsConfig() const override;
 
   /**
    * @brief check if a new version of a config file is available (for specified target)
@@ -1539,17 +1539,17 @@ class RteFileInstance : public RteItemInstance
    * rteFolder is taken from target's parent project
    * @param targetName target name to resolve file
    * @param
-   * @return pointer to RteFile if resolved, nullptr otherwise
+   * @return pointer to RteFile as RteItem if resolved, nullptr otherwise
   */
-  RteFile* GetFile(const std::string& targetName) const;
+  RteItem* GetFile(const std::string& targetName) const;
 
   /**
    * @brief copy a config file from pack location to the designated project directory
-   * @param f pointer to RteFile to copy
+   * @param f pointer to RteFile (or RteItem representing a file) to copy
    * @param bMerge flag indicating to merge it to the existing one (if exists), otherwise overwrite
    * @return true is successful
   */
-  bool Copy(RteFile* f, bool bMerge);
+  bool Copy(RteItem* f, bool bMerge);
 
 public:
 

libs/rtemodel/include/RteItem.h

@@ -523,6 +523,17 @@ class RteItem : public XmlTreeItem<RteItem>
   */
   virtual std::string GetOriginalAbsolutePath(const std::string& name) const;
 
+  /**
+   * @brief construct full path including filename for a file that should be used when adding file to a project
+   * @param deviceName name of device used in the project
+   * @param instanceIndex file index for components with multiple instantiation
+   * Gets appended as a string to the base filename before extension if its value >= 0
+   * Value of < 0 indicates that parent component can have only one instance
+   * @param rteFolder the "RTE" folder path used for placing files
+   * @return full project-relative path including filename and extension
+  */
+  virtual std::string GetInstancePathName(const std::string& deviceName, int instanceIndex, const std::string& rteFolder) const;
+
   /**
    * @brief check if item provides data matching OS this code is built for: Linux, Windows or Mac OS
    * @return true if item data matches host platform
@@ -787,6 +798,18 @@ class RteItem : public XmlTreeItem<RteItem>
   */
   virtual RteItem* GetLicenseSet() const;
 
+  /**
+   * @brief check if this item represents or is associated with a that is a config one
+   * @return true if "attr" attribute value is "config" in default implementation
+  */
+  virtual bool IsConfig() const;
+
+  /**
+   * @brief check if an associated file must be added to project
+   * @return true if to add to project
+  */
+  virtual bool IsAddToProject() const { return IsConfig();}
+
   /**
    * @brief check if item is associated with a condition that depends on selected device
    * @return true if item's condition depends on selected device

libs/rtemodel/include/RteProject.h

@@ -838,7 +838,7 @@ class RteProject : public RteRootItem
    * @param bMerge true to merge source with destination
    * @return true if source can be copied to destination
   */
-  bool UpdateFileToNewVersion(RteFileInstance* fi, RteFile* f, bool bMerge);
+  bool UpdateFileToNewVersion(RteFileInstance* fi, RteItem* f, bool bMerge);
 
   /**
    * @brief get file name and path of "RTE_Components.h" determined by the specified target and prefix
@@ -904,14 +904,14 @@ class RteProject : public RteRootItem
   bool RemoveComponent(const std::string& id);
 
   void AddComponentFiles(RteComponentInstance* ci, RteTarget* target);
-  RteFileInstance* AddFileInstance(RteComponentInstance* ci, RteFile* f, int index, RteTarget* target);
+  RteFileInstance* AddFileInstance(RteComponentInstance* ci, RteItem* f, int index, RteTarget* target);
   bool RemoveFileInstance(const std::string& id);
   void DeleteFileInstance(RteFileInstance* fi);
   // initializes or updates (newer version is used) existing file instance
-  void InitFileInstance(RteFileInstance* fi, RteFile* f, int index, RteTarget* target, const std::string& savedVersion, const std::string& rteFolder);
-  bool UpdateFileInstance(RteFileInstance* fi, RteFile* f, bool bMerge, bool bUpdateComponent);
+  void InitFileInstance(RteFileInstance* fi, RteItem* f, int index, RteTarget* target, const std::string& savedVersion, const std::string& rteFolder);
+  bool UpdateFileInstance(RteFileInstance* fi, RteItem* f, bool bMerge, bool bUpdateComponent);
   void UpdateFileInstanceVersion(RteFileInstance* fi, const std::string& savedVersion);
-  void UpdateConfigFileBackups(RteFileInstance* fi, RteFile* f);
+  void UpdateConfigFileBackups(RteFileInstance* fi, RteItem* f);
 
   void CollectSettings(const std::string& targetName);
 

libs/rtemodel/include/RteTarget.h

@@ -229,7 +229,7 @@ class RteTarget : public RteItem
    * @param c given associated component
    * @return pointer of type RteFile
   */
-  RteFile* GetFile(const std::string& name, RteComponent* c) const;
+  RteItem* GetFile(const std::string& name, RteComponent* c) const;
 
   /**
    * @brief determine file given by an file name and an associated component
@@ -259,7 +259,7 @@ class RteTarget : public RteItem
    * @param c given pointer of type RteComponent
    * @return pointer of type RteFile
   */
-  RteFile* GetFile(const RteFileInstance* fi, RteComponent* c) const;
+  RteItem* GetFile(const RteFileInstance* fi, RteComponent* c) const;
 
   /**
    * @brief determine file given by instances of type RteFileInstance and RteComponent
@@ -268,7 +268,7 @@ class RteTarget : public RteItem
    * @param rteFolder the "RTE" folder path used for placing files
    * @return pointer of type RteFile
   */
-  RteFile* GetFile(const RteFileInstance* fi, RteComponent* c, const std::string& rteFolder) const;
+  RteItem* GetFile(const RteFileInstance* fi, RteComponent* c, const std::string& rteFolder) const;
 
   /**
    * @brief evaluate dependencies of selected components of the target
@@ -945,6 +945,12 @@ class RteTarget : public RteItem
   */
   RteDeviceProperty* GetDeviceEnvironment() const { return m_deviceEnvironment; }
 
+  /**
+   * @brief get <debugvars> property of device
+   * @return RteDeviceProperty pointer
+  */
+  RteDeviceProperty* GetDeviceDebugVars() const { return m_deviceDebugVars; }
+
   /**
    * @brief get the absolute path to the generator input file
    * @return absolute path to the generator input file
@@ -1091,9 +1097,9 @@ class RteTarget : public RteItem
 
   RteComponent* m_deviceStartupComponent; // device startup component being used
   RteDeviceItem* m_device; // device used by target
+  RteDeviceProperty* m_deviceDebugVars; // to access original dbgconfig file
   // environment
   RteDeviceProperty* m_deviceEnvironment; // device environment property for "uv"
-
   // template support
   std::map<RteComponent*, RteFileTemplateCollection*> m_availableTemplates;
   // device values:

libs/rtemodel/src/RteFile.cpp

@@ -54,6 +54,16 @@ bool RteFile::IsConfig() const
   return GetRole() == Role::ROLE_CONFIG;
 }
 
+bool RteFile::IsDeviceDependent() const
+{
+  RteComponent* c = GetComponent();
+  if(c && c->IsDeviceDependent()) {
+    return true;
+  }
+  return RteItem::IsDeviceDependent();
+}
+
+
 bool RteFile::IsTemplate() const
 {
   return GetRole() == Role::ROLE_TEMPLATE;